GithubHelp home page GithubHelp logo

mohamedaemara / library-management-system-api Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 159 KB

Home Page: https://documenter.getpostman.com/view/29997574/2s9Yyy7yKH

JavaScript 100.00%
backend nodejs potgresql rest-api expressjs

library-management-system-api's Introduction

Library Management System

Overview

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.

technologies

Table of Contents

Schema Diagram for DB

schema

Getting Started

Prerequisites

Before getting started, Ensure you have installed the following:

  • Node.js and npm
  • PostgreSql

Installation

  1. Clone the repository: $ git clone [email protected]:MohamedAEmara/Library-Management-System-API.git
  2. Install dependencies: $ npm install
  3. Configure environment variables: Create a .env file in the root directory.
    • Copy .env.example content to .env file
    • Add values for environment variables

      you can set DATABASE_URL by the same like this format: postgresql://USER:PASSWORD@HOST:PORT/DATABASE

  4. Migrate prisma schema to the db by running these commands:
        $ npx prisma generate
        $ npx prisma migrate dev --name init

Endpoints

You can check endpoints & documentation on Postman from here

Technology Stack

The Library Management System API uses the following technologies and tools:

Backend

  • 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.

Documentation

  • Postman: Used to provide a collection for API requests.

Deployment

  • Render: A cloud platform for hosting and deploying web applications.
  • You can try API endpoints on this link: Library Management System

Version Control

  • Git: A distributed version control system.
  • GitHub: A web-based platform for version control and collaboration.

How to Contribute

If you'd like to contribute to the project or have suggestions for improvement, please do not hesitate to make pull request.

library-management-system-api's People

Contributors

mohamedaemara avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.