|
1 | | -# Getting Started with Create React App |
| 1 | +# Women Who Code Front End Study Group Project |
2 | 2 |
|
3 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
4 | | - |
5 | | -## Available Scripts |
6 | | - |
7 | | -In the project directory, you can run: |
8 | | - |
9 | | -### `npm start` |
10 | | - |
11 | | -Runs the app in the development mode.\ |
12 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
13 | | - |
14 | | -The page will reload if you make edits.\ |
15 | | -You will also see any lint errors in the console. |
| 3 | +This repository is a beginner-friendly project started by [Women Who Code Front End](https://www.womenwhocode.com/frontend) to learn about front end technologies as well as how to collaborate on an open source project. |
16 | 4 |
|
17 | | -### `npm test` |
| 5 | +Currently it is deployed at [https://frontendstudygroup.github.io](https://frontendstudygroup.github.io) using [GitHub Pages](https://pages.github.com/). |
18 | 6 |
|
19 | | -Launches the test runner in the interactive watch mode.\ |
20 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 7 | +We are collaborating with [Women Who Code Cloud](https://www.womenwhocode.com/cloud) to implement other deployment methods like deploying the app to Azure or AWS with Continuous Integration and Continuous Delivery pipelines. |
21 | 8 |
|
22 | | -### `npm run build` |
| 9 | +## Expectations |
23 | 10 |
|
24 | | -Builds the app for production to the `build` folder.\ |
25 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
26 | | - |
27 | | -The build is minified and the filenames include the hashes.\ |
28 | | -Your app is ready to be deployed! |
| 11 | +Participation and maintenance of this project is completely voluntary and we are not committing to teach anything as part of this effort. If you want to practice together with us, this is a good place! |
29 | 12 |
|
30 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 13 | +## Code of Conduct |
31 | 14 |
|
32 | | -### `npm run eject` |
| 15 | +- Be respectful to each other |
| 16 | +- No question is stupid, feel free to ask questions and encourage others |
33 | 17 |
|
34 | | -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 18 | +## How To Contribute |
35 | 19 |
|
36 | | -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. |
| 20 | +- Search in [Issues](https://github.com/frontendstudygroup/frontendstudygroup.github.io/issues) for open issues to work on |
| 21 | + - If you would like to make a suggestion for an enhancement, or report a defect, create an issue |
| 22 | +- Fork the repository (recommended if you are doing this for the first time) |
| 23 | +- Assign the issue to yourself |
| 24 | +- Comment in the issue about your approach to solving the problem |
| 25 | +- Get feedback from others |
| 26 | +- Submit a pull request when you are ready |
37 | 27 |
|
38 | | -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. |
| 28 | +Questions about front end? [Join the WWC Front End Slack](https://join.slack.com/t/womenwhocodefrontend/shared_invite/zt-gaic5y90-pDJK4H_NbObZ_MU_rcYc0A) and join the `#fe-beginner-studygroup` channel. |
39 | 29 |
|
40 | | -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. |
| 30 | +Questions about cloud? [Join the WWC Cloud Slack](https://join.slack.com/t/wwcodecloud/shared_invite/zt-lngnes83-iq8TuBLOtAGXnHFaM5~sTw) and join the `#opensource` channel. |
41 | 31 |
|
42 | | -## Learn More |
| 32 | +## Local Setup for Development |
43 | 33 |
|
44 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
| 34 | +This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
45 | 35 |
|
46 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
| 36 | +### Getting Started |
| 37 | +After you clone this repository to your local machine, execute the command `npm install` in your favorite terminal to install all the npm packages locally. |
47 | 38 |
|
48 | | -### Code Splitting |
| 39 | +To run the application locally execute the command `npm start`. |
49 | 40 |
|
50 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) |
| 41 | +Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
51 | 42 |
|
52 | | -### Analyzing the Bundle Size |
| 43 | +The page will reload if you make edits. You will also see any lint errors in the console. |
53 | 44 |
|
54 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) |
| 45 | +### Testing |
55 | 46 |
|
56 | | -### Making a Progressive Web App |
| 47 | +Executing the command `npm test` launches the test runner in interactive watch mode. |
| 48 | +See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) in the Create React App documentation for more information. |
57 | 49 |
|
58 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) |
| 50 | +### Deployment |
59 | 51 |
|
60 | | -### Advanced Configuration |
| 52 | +Executing the command `npm run build` builds the app for production to the `build` folder. |
| 53 | +It correctly bundles React in production mode and optimizes the build for the best performance. |
61 | 54 |
|
62 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) |
| 55 | +The build is minified and the filenames include the hashes. |
| 56 | +Your app is ready to be deployed! |
63 | 57 |
|
64 | | -### Deployment |
| 58 | +See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) in the Create React App documentation for more information. |
65 | 59 |
|
66 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) |
| 60 | +### Learn More |
67 | 61 |
|
68 | | -### `npm run build` fails to minify |
| 62 | +You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
69 | 63 |
|
70 | | -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) |
| 64 | +To learn React, check out the [React documentation](https://reactjs.org/). |
0 commit comments