coders-camp-2021-best-team / TeamUp-Client

GNU General Public License v3.0
4 stars 1 forks source link
coderscamp coderscamp2021 coderscamp2021-dzial-4

TeamUp-Client

This project was made due to the CodersCamp2021

Docs

Deploy on Netlify

Important Notices

.env.example

Before you can start the app, you need to create your own .env file. There are .env.example file with example values that are ready to use.

For Windows users

If you are a Windows user, please use Git Bash or any other UNIX-like shell (e.g. Git Bash). Some commands MAY NOT work on default Windows Command Line.

Available Commands

In the project directory, you can run:

yarn install

Installs all required packages. This is the first command that you should run after cloning this repo. Without this you will not be able to run the app.

cp .env.example .env

Creates env config files with all default values. Without this you will not be able to run the app.

yarn start

Runs the app in the development mode.\ 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.

yarn test

Runs tests.

yarn lint

Checks every source code file using ESLint and rules described in .eslintrc.

yarn format

Formats entire project using Prettier according to formatting rules described in .prettierrc.