This project is initialized with Create React App. It uses React, Redux for state management, React Router Dom for routing, Material UI for styling and Formik for building forms.
All the dependencies can be seen in the package.json file.
To run this project locally you need:
- Node.js (lts)
- Git
- VSCode
- Backend with MongoDB connection
Start by downloading the zip file of this project from GitHub.
Or if you have Git installed
$ git clone https://github.com/Kestava-keikkatyo/innoFrontend.git
You can install Visual Studio Code from here.
After the installation is done, download the ESLint extension to enable linting and allow the execution to run in your workspace.
You don't have to use Visual studio code, any text editor with ESLint support should be fine.
To run this project locally:
$ cd (your_path)/innoFrontend
$ npm install
$ npm start
You also need to have the backend set up and running. The backend needs to be run in port 3001 and it also requires MongoDB database connection.
In the project directory, you can run:
This project was bootstrapped with Create React App.
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.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
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.
Publish static files in the build folder to s3-bucket.
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.
Runs the linter once and shows any linting errors in the project folder.
Linting rules can be found in the ".eslintrc" file.
You don't have to run this command when you have ESLint extension enabled, linting errors should be highlighted automatically.
Runs the linter once and fixes all the linting errors in this project folder.
Creates this projects JSDoc documentation. Destination folder is called docs and it can be found in the root of this project.
JSDoc configuration can be changed in the jsdoc.json file.
Tests are created using Jest with React Testing Library for React components.
To run the tests once, in this project directory:
$ CI=true npm test
To create a coverage report, in this project directory:
$ CI=true npm test -- --coverage
A coverage report is created in the coverage folder of this project. Coverage folder contains both HTML and Cobertura reports.