Propo41 / react_template

A react project made using material UI library for the intention of providing a starting template for future ReactJS projects

Installation

Clone the repository. Open your console and type:

git clone https://github.com/austpic/pic-front-end.git

It is recommended to install the packages using yarn. If you don't have yarn installed already, do the following:

npm install --global yarn
yarn --version

After you have installed yarn, run the following command:

yarn install

Extentions recommended

Code Conventions

• Always make sure to keep your code in a consistent style. Use Cntrl + Alt + F (in windows) to format your code.
• Always use PropTypes in your components. Reference

Env files

.env.development contains the development environment variables. .env.production contains the production environment variables. .env.local contains the local environment variables. Note: variables stored here will only run on the local machine

Possible Issues with their fixes

• Jsconfig.json file gives TS error. fix

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 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