Merge pull request #36 from thibault-cne/new/release

Release v0.1.2

CHANGELOG.md

@@ -1,3 +1,15 @@
+# Version v0.1.2 (Apr 21, 2024)
+
+This is the first release of the PurpleSector API. This version is not complete but should be stable enough to be used in production.
+
+## Major features
+
+- Added a rate limiter to the API backed by a dragonfly database
+- Support to access all tables of the ergast database
+- Added a configuration file to the API (see [config](config.yml) for more details)
+- Dumped the `rocket` web framework in favor of `axum`. This change was made to improve the performance of the API and reduce the number of dependencies
+- Stabilized the API by adding more tests and enhancing the error handling
+
 # Version v0.1.1-alpha (Apr 14, 2024)
 
 ## Warning

README.md

@@ -7,13 +7,17 @@
 
 This is a Fomula API build in Rust and currently under development. The goal is to provide a simple and easy to use API to access the ergast database and in the end, provide a new maintained database after the 2024 season.
 
-## Project Roadmap
-
-- [x] Create all the basic API endpoints to access the ergast DB
-- [ ] Add a configuration file to the API
-- [ ] Create a complete swagger documentation
-- [ ] Create an automated tool to update the DB in prevision of the ergast deprecated DB for next season
-- [ ] Create a new DB for the F2 championship (maybe even F3 and F1 academy as well as WEC or other championships)
-- [ ] Add a predictor to the API (an LLM model that will try to predict upcoming races results)
-- [ ] Create a landing page for the API
-- [ ] Create a simple front-end to access the API
+## Prerequisites
+
+To build and run the PurpleSector API, you need to have the following tools installed on your system:
+
+- [Rust](https://www.rust-lang.org/tools/install)
+- [Docker](https://docs.docker.com/get-docker/)
+
+## Development
+
+To run the PurpleSector API locally, follow these steps:
+
+1. Clone the repository: `git clone https://github.com/thibault-cne/purple-sector.git`
+2. Run the database: `docker-compose up -d database dragonfly`
+3. Run the project: `cargo run --release`