Skip to content

Latest commit

 

History

History
97 lines (57 loc) · 4.12 KB

README.md

File metadata and controls

97 lines (57 loc) · 4.12 KB

This project was bootstrapped with Create React App.

Prerequisites:

  • You have already forked the repository and cloned your fork to your local machine. More information on this, and the fork and pull model in general, see the gist post on the subject.

  • You have the following installed:

Getting Started:

  1. Open the command prompt and set the working directory as the client directory of your cloned repository. (cd client)
  2. Run yarn install --frozen-lockfile to install all the required dependencies
  3. Run yarn start to launch the application. Close the application with ctrl+c in the command prompt

When I start my app, why does it keep loading??

  1. Stop the app (if it is running)
  2. Add a .env file to ./client/.env
  3. Add REACT_APP_GOOGLE_CLIENT_ID=<client-id> (Ask Nisarag if you can't find the client-id)
  4. Start the app again

Available Scripts

In the project directory, you can run:

yarn install --frozen-lockfile

Installs required dependencies to run the project.

yarn add nodemon npm-run-all --dev

Installs the dev dependecies that allow the proxy-server and React app to run in parallel

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

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.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

yarn build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify