Real life library api
Report Bug
·
Request Feature
Table of Contents
Readify-Api is an API to manage a network of library and book related to where user can search for a book, see where the book is available and borrow or reserve it.
/* This project was created for educational purposes */
- State of the Project => Pre-release v.0.8.0
- Main difficulties - Roadmap
This section should list any major frameworks/libraries used to bootstrap your project.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
- Clone the repo
git clone https://github.com/JulesEfrei_/readify-api.git
- Start the application with docker
docker compose up -d
- Setup the migrations & load fixtures
docker compose exec app php bin/console doctrine:migrations:migrate -n docker compose exec app php bin/console doctrine:fixtures:load # (Optionnal)
- Start the project with docker
docker compose up -d
- Navigate to localhost:8000/api to see the documentation of the API
Here is the roadmap of the project. Checked flags mean the features is out and unchecked flags mean that the feature is comming.
- JWT Authentication
- CRUD on all entities
- Boosted reviews
- Multi copy book management
- Borrow system
- Basic filter
- Access to sub-resources
- Get status of a book
- Advanced search
- User history
- Reservation system
- Reminders (for borrow and reservation)
- Book statistic
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
List of people
Linked'in - Jules
GitHub Profile: JulesEfrei
Distributed under the MIT License. See LICENSE.txt for more information. If no license is available in the repository, it will be available one day, I hope.