|
1 | | -# coding.space |
| 1 | +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
2 | 2 |
|
3 | | -http://coding.space |
| 3 | +## Available Scripts |
4 | 4 |
|
5 | | - |
| 5 | +In the project directory, you can run: |
6 | 6 |
|
7 | | - |
| 7 | +### `npm start` |
8 | 8 |
|
9 | | - |
| 9 | +Runs the app in the development mode.<br /> |
| 10 | +Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
10 | 11 |
|
11 | | -## How to contribute to the curriculum |
| 12 | +The page will reload if you make edits.<br /> |
| 13 | +You will also see any lint errors in the console. |
12 | 14 |
|
13 | | -### Getting set up |
| 15 | +### `npm test` |
14 | 16 |
|
15 | | -1. Create an account at https://c9.io -- it'll ask for a credit card, but it won't charge you. |
| 17 | +Launches the test runner in the interactive watch mode.<br /> |
| 18 | +See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
16 | 19 |
|
17 | | -2. Create a new HTML workspace for you to work on coding.space in. |
| 20 | +### `npm run build` |
18 | 21 |
|
19 | | -3. Create a GitHub account |
| 22 | +Builds the app for production to the `build` folder.<br /> |
| 23 | +It correctly bundles React in production mode and optimizes the build for the best performance. |
20 | 24 |
|
21 | | -4. Fork the [coding.space repo](https://github.com/stevekrouse/coding.space) to your github account by clicking the Fork button |
| 25 | +The build is minified and the filenames include the hashes.<br /> |
| 26 | +Your app is ready to be deployed! |
22 | 27 |
|
23 | | -4. Clone your forked repo with this command in the Cloud9 terminal: |
| 28 | +See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
24 | 29 |
|
25 | | - ``` |
26 | | - git clone https://github.com/YourGithubUsername/coding.space.git |
27 | | - ``` |
| 30 | +### `npm run eject` |
28 | 31 |
|
29 | | -4. Now you can add or edit anything you want without affecting the actual website. |
| 32 | +**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
30 | 33 |
|
| 34 | +If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
31 | 35 |
|
32 | | -### Making changes and additions |
| 36 | +Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
33 | 37 |
|
34 | | -1. Take a look at scratch/ , woof/ , and web/ to familiarize yourself with the directory structure. Make sure you create new files in the right place. |
| 38 | +You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
35 | 39 |
|
36 | | -2. When creating a new untutorial, it's a good idea to make a copy of an existing untutorial, rename it, and use it as a template. That way, you can make sure the style and layout are uniform. |
| 40 | +## Learn More |
37 | 41 |
|
38 | | -3. When you're finished making the untutorial, add a screenshot thumbnail of the project to the proper images/ subfolder ( scratch/images/ | woof/images/ | web/images/ ). |
| 42 | +You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
39 | 43 |
|
40 | | -4. Add a link to your new untutorial in the proper index.html file ( scratch/index.html | woof/index.html | web/index.html ) and include the thumbnail. Use your judgment when choosing which level it belongs in. |
| 44 | +To learn React, check out the [React documentation](https://reactjs.org/). |
41 | 45 |
|
42 | | -5. When your changes are complete, create a new local branch and commit your changes to it. Give your branch a descriptive name, like "catch-the-mouse-untutorial" |
43 | | - ``` |
44 | | - git checkout -b catch-the-mouse-untutorial |
45 | | - ``` |
| 46 | +### Code Splitting |
46 | 47 |
|
47 | | -6. Then add, commit and push the branch to your github repo. |
48 | | - ``` |
49 | | - git add . -p |
50 | | - git commit -m "my changes" |
51 | | - git push |
52 | | - ``` |
| 48 | +This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting |
53 | 49 |
|
54 | | -7. Submit a pull request to the main `stevekrouse/coding.space` repo and await approval or feedback. |
| 50 | +### Analyzing the Bundle Size |
55 | 51 |
|
| 52 | +This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size |
56 | 53 |
|
57 | | -If you want to get quick feedback before pushing your branch and making a pull request, you can send Steve a link to your project/changes on c9.io |
| 54 | +### Making a Progressive Web App |
58 | 55 |
|
59 | | -#### Embedding Scratch projects |
| 56 | +This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app |
60 | 57 |
|
61 | | -* For Scratch projects, to embed step-by-step examples, go to the project page on Scratch, and click "embed" -- you can copy/paste the iframe from there. |
| 58 | +### Advanced Configuration |
62 | 59 |
|
63 | | -#### Adding Woof projects |
| 60 | +This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration |
64 | 61 |
|
65 | | -* For Woof projects, please include the code for the full project in the `coding.space/woof/code/` directory so that it can serve as the answer key for our teachers. |
| 62 | +### Deployment |
66 | 63 |
|
67 | | -* Save all images in the`coding.space/woof/images` directory and all audio in the `coding.space/woof/audio` directory. Do not hard link. |
| 64 | +This section has moved here: https://facebook.github.io/create-react-app/docs/deployment |
68 | 65 |
|
69 | | -* Step-by-step examples of the project should be included in the `coding.space/woof/snippets` directory and linked to from your untutorial. |
| 66 | +### `npm run build` fails to minify |
70 | 67 |
|
71 | | -* Please don't embed examples for Woof projects as iframes -- they tend to slow things down on woofjs.com. Just include a link instead. |
| 68 | +This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify |
0 commit comments