Skip to content

Commit f24b0d0

Browse files
committed
Add initial README.md with project overview
1 parent 165b632 commit f24b0d0

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# F1DataLab - A Formula 1 Data Visualization Site
2+
3+
_This project is under active development. Future features will include a driver-to-driver comparison tool to analyze lap times, race positions, and other key performance metrics._
4+
5+
_The current dataset is historical and does not contain the latest racing data. Future updates will incorporate more recent results._
6+
7+
[![App Tech](https://skillicons.dev/icons?i=py,fastapi,next,ts,mysql,docker,)](https://skillicons.dev)
8+
9+
### **Live Site:** [**formula1datalab.com**](https://formula1datalab.com/)
10+
11+
F1DataLab is a full-stack web application built to showcase modern development practices and provides a platform to explore and visualize historical racing data.
12+
13+
## Key Features
14+
15+
The application provides an interactive experience for exploring Formula 1 data through a variety of charts and tables:
16+
17+
* **Race Results:** Explore data from individual races, including finishing positions, and other key race events visualized in clear, informative charts.
18+
* **Driver Analytics:** Analyze driver performance, career milestones, and year-over-year results with intuitive graphs.
19+
* **Constructor Insights:** View detailed statistics and performance data for F1 constructors across different seasons.
20+
21+
## Containerization & Deployment
22+
23+
The entire application is containerized using Docker, ensuring consistency across development and production environments.
24+
25+
* **Container Orchestration:** Docker Compose is used to define and manage the multi-container application stack (frontend, backend, database, and reverse proxy).
26+
27+
* **Efficient Production Builds:** The production environment utilizes a multi-stage Docker build strategy.
28+
1. The Next.js frontend is built once into a lean, production-ready image.
29+
2. The Nginx image is then created by copying only the necessary static assets (`.next/static` and `public`) from the pre-built frontend image. This results in a small, secure, and highly efficient Nginx container that serves the static content.
30+
31+
* **Reverse Proxy & SSL:**
32+
* [**Nginx**](https://www.nginx.com/) serves as the reverse proxy, directing traffic to the appropriate frontend or backend service.
33+
* [**Let's Encrypt**](https://letsencrypt.org/) is used to automatically provision and manage SSL certificates, ensuring all traffic is served over HTTPS.
34+
35+
36+
## License
37+
38+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)