Booksy is a social cataloging application that allows its users to find books and gives personalized suggestions. Users can sign up and add books to their reading lists called shelves and track their advancement.
| ID | Description | Difficulty | Priority | State |
|---|---|---|---|---|
| #1 | A user can create an account. | 2 | HIGH | DONE |
| #2 | A user can check the detailed book page. | 1 | HIGH | DONE |
| #3 | A user can check the most rated books. | 2 | LOW | DONE |
| #4 | A user can search and filter books by genre, title, author,content,... | 1 | HIGH | DONE |
| #5 | A user can create shelves with a name, by default there will be a "To read", "read" and "reading" shelves. | 1 | HIGH | DONE |
| #6 | A user can add a book to his shelves. | 1 | HIGH | DONE |
| #7 | A user can update his reading status. | 1 | HIGH | DONE |
| #8 | A user can write reviews on books from 0 to 5. | 1 | LOW | DONE |
| #9 | A user can login using Auth0. | 2 | HIGH | DONE |
| #10 | A user can get suggestions on the books he is currently viewning. | 2 | HIGH | DONE |
This application uses an Express.js Backend coupled with an Angular front.
To run the app on a local developement environement do as follows :
- run
npm install. - To run the front
cd clientand thennpm start, then navigate tohttp://localhost:4200. - To run the back
cd serverand thennpm run start:dev, the server is run on port3000. - You need to have a Google API key linked to the Google Book's API and add to the
.envfile (see.env.example).
- To run the app just run
docker-compose up(you need to have Docker installed). - The application is also deployed on: https://booksy-api.herokuapp.com
The API docs are available here.
- Abdelhadi Naimi
- Yassine Mohammed Cherifi
- Wassim Berrari
- Fatima Ezzahra Bakir
Booksy - Université de Bordeaux.