Library Management System is an API that allows users to create, delete, update, read books. It also provides CRUD operations for Borrowers. Users can borrow a book and keep track of all valid copies of books, get all borrowings and dueDates.
Before getting started, Ensure you have installed the following:
- Node.js and npm
- PostgreSql
- Clone the repository:
$ git clone git@github.com:MohamedAEmara/Library-Management-System-API.git - Install dependencies:
$ npm install - Configure environment variables: Create a
.envfile in the root directory.- Copy .env.example content to
.envfile - Add values for environment variables
you can set
DATABASE_URLby the same like this format:postgresql://USER:PASSWORD@HOST:PORT/DATABASE
- Copy .env.example content to
- Migrate prisma schema to the db by running these commands:
$ npx prisma generate $ npx prisma migrate dev --name init
You can check endpoints & documentation on Postman from here
The Library Management System API uses the following technologies and tools:
- Node.js: The server-side runtime environment for executing JavaScript code.
- Express.js: A minimal and flexible Node.js web application framework for building robust APIs.
- PostgreSQL: A powerful open-source relational database used for storing books and borrowers.
- Prisma: A modern database toolkit and ORM for Node.js and TypeScript.
- Postman: Used to provide a collection for API requests.
- Render: A cloud platform for hosting and deploying web applications.
- You can try API endpoints on this link: Library Management System
- Git: A distributed version control system.
- GitHub: A web-based platform for version control and collaboration.
If you'd like to contribute to the project or have suggestions for improvement, please do not hesitate to make pull request.