This repository is a collection of React components to display useful information as charts about the server population.
This project is built using Vite, a modern build tool that provides a faster development experience compared to traditional bundlers like Webpack.
The chart was done with AmChart 4 and inspired by this example.
The application was safely typed with TypeScript.
- Setup .env to your server (check .env.example)
- Install NPM 10.x and Node 20.x or later via NVM
- npm install
- npm start
Dev/Local profile support is not currently available (see #8), but you can mock data using this mocked JSON.
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.
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!
Previews the production build locally.
This command serves the build files, allowing you to see how your app will look in production before deploying.
Runs ESLint on the project files with .js, .jsx, .ts, and .tsx extensions and attempts to fix any fixable issues.
Formats the project files using Prettier. This will apply code style changes to the files.
Runs ESLint to fix issues and then runs Prettier to format the code. This ensures that the code is both linted and formatted.
- Install Visual Studio Code
- Follow the conventional commits guideline
- Commit messages are formatted with commit-lint
- Code is formatted with Prettier
- Open pull-requests