https://github.com/vkbansal/formula1-app

F1 statistics and data-viz
https://github.com/vkbansal/formula1-app

data-visualization formula1 static-site-generator statistics

Last synced: 3 days ago
JSON representation

F1 statistics and data-viz

• Host: GitHub
• URL: https://github.com/vkbansal/formula1-app
• Owner: vkbansal
• License: mit
• Created: 2021-02-26T12:48:54.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T15:14:42.000Z (7 months ago)
• Last Synced: 2024-04-14T22:20:27.289Z (7 months ago)
• Topics: data-visualization, formula1, static-site-generator, statistics
• Language: Astro
• Homepage: https://f1.vkbansal.me
• Size: 124 MB
• Stars: 5
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Formula 1 Statistics

An app for statistics and data visualizations around **The Formula 1 World Championship**. The main goal of this project is to be restricted as a Static Site and uses [Astro](https://astro.build/) as the static site generator and [Preact](https://preactjs.com/) for interactive elements.

## Data Source

The data is taken from http://ergast.com/mrd/.

## Local development

### Prerequisites

- [nodejs](https://nodejs.org/)

- [pnpm](https://pnpm.io/)

- [docker](https://www.docker.com/) - only required for working with data

### Development

- Clone the repository: `git clone [email protected]:vkbansal/formula1-app.git`

- Change to the project directory and run `pnpm install`.

- Run `pnpm run dev` to start the local development server. This will start Astro's development server and logs the url in console.

- The source code resides in `src` folder.

- All the data is stored as `.json` files under `src/content` folder to utilize [Astro's content collection API](https://docs.astro.build/en/guides/content-collections/).

- To download latest data, run `pnpm run data:up`.

- To update data, once newer data is downloaded:

  - Run `docker compose up -d` to startup MariaDB and populate it with data.

  - Run `pnpm run data:gen` to update the data. You might have to wait for about minute before running this command after you have run previous docker command in order for the database to be ready.

- Data generation related code resides in `tools` folder.

## License

[MIT](./LICENSE.md)