Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tarek99samy/formula1-explorer

A website that allows users to explore Formula 1 seasons, races, and driver details.
https://github.com/tarek99samy/formula1-explorer

babel eslint formula1 primereact react-query reactjs sass tanstack-react-query vite zustand

Last synced: 1 day ago
JSON representation

A website that allows users to explore Formula 1 seasons, races, and driver details.

Awesome Lists containing this project

README

        

# Formula 1 Explorer

This is a Formula 1 Explorer website that allows users to explore various aspects of Formula 1 racing, including drivers, teams, and race results. The website is built using modern web technologies to ensure a fast and mobile-first responsive user experience.

## Tech Stack

- **React**: A JavaScript library for building user interfaces.
- **Vite**: A build tool that provides a fast development environment with Hot Module Replacement (HMR).
- **PrimeReact**: A rich open-source UI components for React applications.
- **SASS**: A preprocessor scripting language that is interpreted or compiled into CSS.
- **React Query**: A library for fetching, caching, and updating asynchronous data in React applications.
- **Zustand**: A small, fast, and scalable state management library for React applications.
- **ESLint**: A tool for identifying and fixing problems in JavaScript code.
- **Babel**: A JavaScript compiler that allows you to use next-generation JavaScript.
- **Vitest**: A testing framework for JavaScript applications that provides a fast and enjoyable testing experience.

## Setup

1. **Clone the repository:**

```sh
git clone https://github.com/yourusername/formula1-explorer.git
cd formula1-explorer
```

2. **Install dependencies:**
```sh
npm install
```

## Running the Development Server

To start the development server with Hot Module Replacement (HMR), run:

```sh
npm run start
```

This will start the Vite development server and you can view the website at `http://localhost:5173`.

## Building for Production

To build the project for production, run:

```sh
npm run build
```

This will create an optimized production build in the `dist` directory.

## Linting

To lint the codebase using ESLint, run:

```sh
npm run lint
```

## Testing

To run tests using Vitest, run:

```sh
npm run test
```