Copyright Juhani Vähä-Mäkilä (juhani@fmail.co.uk) 2022.\
Licenced under EUROPEAN UNION PUBLIC LICENCE v. 1.2.
-
React 18.2.x
-
React Router
-
Node 16
-
TypeScript
-
Bulma css
-
FontAwesome icons
Highly recommended IDEs are JetBrains WebStorm or VSCode. Theres is also a vscode workspace file in repository. If you want to make coding more effortless, you should install ESLint and Prettier plugins to your editor.
Before installing dependencies you should generate Github Personal Access Token and add it to your ~/.npmrc file like this:
//npm.pkg.github.com/:_authToken=<TOKEN>
CSS file can be generated with this command:\
npm run css-build
There are also scripts to ensure code quality and consistency. They are run automatically on pull requests, but you can also run them by hand. If you want to autoformat all files, you can run npx prettier --write .
When developing components, you can use storybook, where you can develop them in isolation and reach states that are not pleasantly reached otherwise. Also, when project grows, all developers can find and browse all implemented components easily. You can start storybook by running npm run storybook.
Features/bug fixes are to be developed in their own branches.
In the project directory, you can run:
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.
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.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.