Make it more explicit how to start

[JLou]

Issue and Steps to Reproduce

Right now you have to guess that in order to use that starter kit, you need to clone it.
It would be great to see steps to get started, and also precisions to remove git metadata if you clone this inside an existing project:
You have an existing repo with your application, with that tree structure:

└── /
    ├── client/
    │   └── frontendapp1
    └── server/
        ├── backend1
        └── backend2

You want to start a new project inside /client/frontendapp2. You cannot just clone and change origin. You need to remove the git folder.

One solution is to

git clone --depth=1 --branch=master https://github.com/AxaGuilDEv/react-starter.git frontendapp2
rm -rf ./frontendapp2/.git

depth=1 to avoid copying too much history, then remove the .git folder

The other is to recommend downloading an archive (not great imo)

Cleanup

Also, there is a lot of clutter after clone (all the .MD files). Would be great to have a nice way to get rid of them!

[johnmeunier]

Why do you want delete the git history when you begin a new project with the starter ?
When I create a new project, I just change the url of the origin remote.

[JLou]

I want to delete this repo's history when cloning inside an exsting application repository, as stated in my previous comment. I've updated it to make it clearer.
The gist of it is

before

└── /
    ├── client/
    │   └── frontendapp1
    └── server/
        ├── backend1
        └── backend2

after

└── /
    ├── client/
    │   ├── frontendapp1
    │   └── frontendapp2 <--- my new project i want to start with the starter
    └── server/
        ├── backend1
        └── backend2

Also, why would you want the history of this repo, even when starting fresh in a new repository containing only my app? It pollutes my app's git history and I am unlikely to pull from upstream to get updates from the starter kit

[johnmeunier]

I agree for a subproject. We won't manage submodules.

For a fresh new repository, it gives the possibility to understand the history of a component, know who develop it, etc. But it's not essential.

Any other opinions ?