This repository is a beginner-friendly project started by Women Who Code Front End to learn about front end technologies as well as how to collaborate on an open source project.
Currently it is deployed at https://frontendstudygroup.github.io using GitHub Pages.
We are collaborating with Women Who Code Cloud to implement other deployment methods like deploying the app to Azure or AWS with Continuous Integration and Continuous Delivery pipelines.
- 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!
- We highly encourage you not to use third party UI frameworks. For example, if you want to design a carousel or a tooltip, do it from scratch.
However we do understand that sometimes we need to use some third party libraries like redux or react-dom-router. When in doubt discuss it on the issue you are working on.
- Find your motivation to contribute to this repository and make sure you have the time.
Life happens, we get it. Just let us know if you cannot do something you're assigned to and do NOT feel guilty about it.
- Things work best for all of us when contribution goals are driven by you. We as maintainers will only guide you and validate your thought process.
- Be open and honest in your communication.
- Be selfish! Aim to do what you intend to learn and do not feel forced to work on something against your will.
- Be respectful to each other
- No question is stupid, feel free to ask questions and encourage others
- Search in Issues for open issues to work on
- If you would like to make a suggestion for an enhancement, or report a defect, create an issue
- Fork the repository (recommended if you are doing this for the first time)
- Clone your forked repository to your machine (
git clone [url from clone option]) - Request to assign the issue for yourself
- Comment on the issue about your approach to solving the problem
- Get feedback from other contributors or project maintainers
- Submit a pull request when you are ready
- Add a title and small description in the pull request about what you did.
- Make sure to reference the issue number in the pull request comment with the words "Fixes #[issue number]" or "Resolves #[issue number]" as explained in GitHub documentation.
Questions about front end? Join the WWC Front End Slack and join the #fe-beginner-studygroup channel.
Questions about cloud? Join the WWC Cloud Slack and join the #opensource channel.
This project was bootstrapped with Create React App.
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.
To run the application locally execute the command npm start.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits. You will also see any lint errors in the console.
Executing the command npm test launches the test runner in interactive watch mode.
See the section about running tests in the Create React App documentation for more information.
There is a GitHub action set up on this repository to build the React app, run tests and deploy to the GitHub Pages site on every merge to the master branch.
Also when a pull request is created or updated, the GitHub action will build the React app and run tests. If the build or tests fail, the pull request will be blocked from merging until they are resolved.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.