yasincandev / codybrains

Capstone Project

You'll be building this project with your peers. You'll be able to read more about the project you will build on your Canvas.

Issues and Pull Requests

We will use GitHub to manage the project. Any issue (or task) will be created during your team's Sprint Planning. Then once assigned to you, you will have to implement the feature and create a PR.

The PR needs to have at least 2 reviewers from your peers. Once they review it within 24 hours, you can either merge it or, in case changes are requested, you will have to make the changes and then ask for another review.

⚠️ Never push to main branch. Always use a new issue and PR to merge your work.

Commits

You should commit on each step and make sure your commits mention the issues it fixes.

Before committing, you need to run linter and prettier:

yarn lint

📌 In case this command shows you a warning, you need to go and fix these warnings.

yarn format

💡 This command will format your code using prettier.

Each commit must have a prettier run before they are staged and committed.

Pull Requests and Issues Templates

It would be best if you made sure to fill out all the details for the PR and Issue template. Once you create a PR, it will show you what data you need to fill in and some checkboxes to tick.

Tests

Adding tests to your components maybe hard at the start, you can check some resources on writing unit tests for React. And try to add some yourself.

Showing your employer that you care about writing tests, is a competitive advantage!

Reverting Files

Sometimes, to test our components, we need to edit some files that are not relevant to the issue.

For example, to test a component, we may need to change App.js to show only our component while building it.

You need to make sure that before you commit, you change App.js back to how it was before your change. The reviewer can then test your component however they like.

💡 Always make sure that the Files Changed tab in the PR has only the relevant files for the issue.

---

Getting Started with Create React App and Redux

This project was bootstrapped with Create React App, using the Redux and Redux Toolkit template.

Available Scripts

In the project directory, you can run:

yarn start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

yarn eject

Note: this is a one-way operation. Once you eject, you can't go back!

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.

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.

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.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.