Web client for IT[M]Optics built with React + Redux
Make sure you have git, node (tested with 18.12.1 version), and yarn installed.
Clone this repository:
git clone git@github.com:itmo-corp/itmoptics-web.git
Install dependencies:
yarn install
Need more detailed installation instructions? We have them.
Run locally:
- Development: run
yarn start, then go to http://localhost:3000 - Production: run
yarn buildto build, then you can runnpx serve -s build -p 8080to run your build on http://localhost:8080
In the project directory, you can run:
Please, run this script before pushing, there are the same commands as in CI.
Checks unused dependencies.
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.
Generate coverage data. Using by CI.
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.
Builds the app for production and deploys it to Netlify.
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.
Fixes formatting errors found in the code and overwrites them. See Prettier to learn more
The same as the yarn prettier, but uses the ESLint configuration over the Prettier configuration.
Linter will look through all the files in the src directory and output a detailed report on the files in which it found errors.
Using this report, you can correct these errors.
To learn more, see ESLint.
ESLint will perform the same check that was performed with yarn lint.
The only difference is that in this mode, the system will try to correct the detected errors,
try to bring the code into as decent a form as possible.
Generate JSDoc documentation. To view it, run docs/index.html in browser.
To learn more, see JSDoc docs.
Run yarn test to launch the test runner in the interactive watch mode.
Check the quality of code with yarn lint
The project is available as open source under the terms of the MIT License. Copyright 2022 Max Barsukov