Untis Book Rent Backend

This project is a REST API for a library management system, which allows users to manage books, book rentals, school classes, and user accounts.

Features

• User authentication and authorization
• Book management
• Book rental management
• School class management

Getting Started

These instructions will help you set up the project on your local machine for development and testing purposes.

Prerequisites

• Node.js >= 14.x.x
• npm >= 6.x.x
• PostgreSQL >= 12.x.x
• TypeScript >= 4.x.x

Installation

1. Clone the repository:

git clone [email protected]:Cylop/untis-book-rent-backend.git

2. Install dependencies:

npm install

3. Create a .env file in the root directory and set the environment variables as required.

ISBNDB_KEY=
ISBNDB_URL

NODE_ENV
PORT

DB_URL
DB_HOST
DB_PORT
DB_USER
DB_PASSWORD
DB_DATABASE

SECRET_KEY

LOG_FORMAT
LOG_DIR

ORIGIN

4. Compile TypeScript files:

npm run build

5. Start the development server:

npm run dev

Running the tests

Run the following command to execute the tests:

npm test

Built With

• Express - Web framework for Node.js
• TypeORM - Object-relational mapping library for TypeScript and JavaScript
• TypeScript - Typed superset of JavaScript

Contributing

Please read the CONTRIBUTING.md file for details on the process for submitting pull requests to the project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.