https://github.com/abesto/ams2-career

react simracing

Last synced: about 1 year ago
JSON representation

Host: GitHub
URL: https://github.com/abesto/ams2-career
Owner: abesto
License: unlicense
Created: 2022-01-30T10:37:58.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-04-01T17:05:48.000Z (about 2 years ago)
Last Synced: 2025-03-15T06:52:43.875Z (about 1 year ago)
Topics: react, simracing
Language: TypeScript
Homepage: https://ams2-career.abesto.net
Size: 6.12 MB
Stars: 6
Watchers: 2
Forks: 1
Open Issues: 18
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# `ams2-career`

[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)

A simple external career mode for Automobilista 2, built as a web application for desktops and mobile browsers. For the user guide, head to the wiki: https://github.com/abesto/ams2-career/wiki

The rest of this README serves as minimal technical documentation.

## Basic Details

Main libraries / frameworks:

- https://redux-toolkit.js.org/
- https://mui.com/

Points of interest:

- `src/types` defines the data model
- `src/store` contains customizations to the Redux store, including saving / loading into Local Storage, and simple save versioning / migration support.
- `src/app/data` contains static data curated manually in CSV files, and code to access that data
- `src/app/components` contains components used in multiple pages / containers
- `src/app/slices` contains [slices](https://redux-toolkit.js.org/api/createslice) used in multiple pages / containers
- `src/pages` is where most of the UI lives

Local development is super simple:

- `yarn install`
- `yarn start` starts a development server, and tries to open your browser to load it. This has live reloading, error reporting, debugging support, the works.
- `yarn test` runs tests, obviously. At the time of writing coverage is extremely spotty. Help improve it?

The data shipped with the app is maintained in [this Google
Sheet](https://docs.google.com/spreadsheets/d/1v4awipFv6t0RVoDaFyY8n5JgqQFdUKeXmKZN_hwTu0Q/).
`yarn run update-data` fetches the current contents into the source tree (which
is packaged with the app at build time).

Contributing: make a pull request :) Ideally add a few tests as well for the code you're adding / changing.

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

_rsr427
🖋 🔣 🤔

_{Zoltán Nagy}
💻 📖 🎨

_{CaptainSlow72}
🤔 🐛