Skip to content

Latest commit

 

History

History
112 lines (90 loc) · 4.13 KB

README.md

File metadata and controls

112 lines (90 loc) · 4.13 KB

LibraryOnline

Logo

ENDPOINT METHOD REQUEST RESPONSE FUNCTION
api/auth POST JSON BODY (credentials) JSON (JWT token) returns token after successfully authorization
api/books GET - JSON (books) returns all books
api/books POST JSON BODY (book) JSON (uuid) creates new book
api/books/{uuid} GET PATH VARIABLE (uuid) JSON (book) returns book with given uuid
api/recommended GET - JSON (books) returns all recommended books
api/genres GET - JSON (genres) returns all genres
api/genres POST JSON BODY (genre) JSON (uuid) returns new genres
api/genres{name} GET PATH VARIABLE (name) JSON (genre) returns genre with given name

Tech Stack

Code:
Static Badge Static Badge Postgres MySQL
FrontEnd:
HTML5 CSS3 JavaScript
Other:
Docker Maven Github

How to build the project on your own

To build the project:

  1. Clone the repository:
  2. git clone https://github.com/hadala-p/RATEmyREAD.git
    
  3. Go to the folder with cloned repository
  4. Run the command on all services:
  5. mvn package 
    
  6. In folder target you should find a file named: application-{version}-SNAPSHOT.jar

To build the docker image with Docker Compose:

  1. Clone the repository:
  2. git clone https://github.com/hadala-p/RATEmyREAD.git
    
  3. Go to the folder with cloned repository
  4. Run the command:
  5. docker-compose build
    
  6. By using:
    docker images
    

Test accounts

ROLE EMAIL PASSWORD
ADMIN admin@library.com adminpass
EDITOR editor@library.com editorpass
USER user@library.com userpass

Frontend

Logo

Logo

Recommended

Logo

Top 10

Logo

Book Details

Logo

Rating System

Logo

Genres

Logo

Admin Panel

Logo

Book Adding Form

Logo

Genre Adding Form

Logo

Login Form

Logo

Error 404

Logo