/books-library

Primary LanguageTypeScript

Books Library API

This API allows applications to access and manipulate library data from the database.

Installation and Setup

To install and setup the project locally, please follow the following instructions:

  1. Run git clone https://github.com/omareldamiry/books-library.git at your preferred directory.
  2. Navigate to the newly generated /books-library directory.
  3. Run npm install or yarn to add all the necessary dependencies.
  4. Run npm start or yarn start to start the server.

Documentation

After running the project locally, visit your localhost:3000/api-docs to view the documentation for all the endpoints and models involved in the API.

Tech stack

This project uses the following technologies:

  • Node.js
  • Express.js
  • TypeScript
  • Swagger docs
  • JSON (database)