Skip to content

Commit 1459614

Browse files
committed
added readme
1 parent e67d7a7 commit 1459614

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,31 @@
11

2+
# Function Camp - Create React App Seed
3+
4+
This project is similar to running `npx create-react-app` with some differences:
5+
6+
- It has prettier built in
7+
- When you run `git commit` it checks the lint / prettier formats your code for you
8+
- It has a Github actions build, so you can check builds pass when you practice with Pull Requests
9+
- All files are lowercase, because we're not savages!
10+
11+
## Setup
12+
13+
Make sure you have a recent version of node installed and yarn installed.
14+
15+
Run:
16+
17+
```bash
18+
git clone https://github.com/z-dev/create-react-app-seed.git my-project
19+
cd my-project
20+
yarn install
21+
rm -rf ./.git # deletes all the git things
22+
git init # creates a new git repo from scratch
23+
git commit -m 'Initial commit'
24+
git remote add origin https://github..../you/your-repo # link the repo to your github repo
25+
git push origin master # push it to your repo
26+
yarn start # get to work!
27+
```
28+
229
## Ejecting
330

4-
Do not eject unless you absolutely have to. It loses most of the benefits of using this. We're using rewired to edit webpack config.
31+
Do not eject unless you absolutely have to. It loses most of the benefits of using this. You could try using [customize-cra](https://github.com/arackaf/customize-cra) instead.

0 commit comments

Comments
 (0)