Skip to content

VitorCarvalho67/TSLibraryAPI

Repository files navigation

TSLibraryAPI (Node.js API)

GitHub license GitHub stars GitHub stars CI GitHub stars

TSLibraryAPI is a robust and versatile REST API built with Node.js, utilizing Prisma as its ORM and TypeScript for enhanced reliability and developer experience. Designed specifically for library management systems, it offers comprehensive functionalities ranging from handling book rentals, managing book and author records, to tracking user interactions. Its efficient and intuitive design ensures seamless integration and scalability, making it ideal for both small-scale library applications and larger, more complex systems. With TSLibraryAPI, managing a library's digital operations becomes a streamlined and efficient process, providing a solid foundation for developers looking to build or enhance library management software.

How To Use

Prerequisites

  • Node.js
  • TypeScript
  • Docker-Compose
  • Nginx
  • Prisma
  • Vitest
  • MySQL

Clone this repository

git clone https://github.com/VitorCarvalho67/TSLibraryAPI.git

Navigate to the project directory

cd TSLibraryAPI

up migration

npx prisma migrate dev --name init

Important

remember to uncomment .env.example and remove .example from the file name.

Run server side

yarn dev

Runnig with Docker

docker-compose up -d

Contributing

Contributions to this project are welcome. Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Commit your changes.
  4. Push to the branch.
  5. Submit a pull request.