Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rakibul58/borrowverse
https://github.com/rakibul58/borrowverse
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/rakibul58/borrowverse
- Owner: rakibul58
- Created: 2024-11-10T13:17:45.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-27T13:49:55.000Z (about 1 month ago)
- Last Synced: 2024-11-27T14:43:56.046Z (about 1 month ago)
- Language: TypeScript
- Size: 60.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# BorrowVerse
## Library Management System
[Live URL](https://library-management-system-six-sage.vercel.app/)
### Table of Contents
- [Project Overview](#project-overview)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Usage Guide](#usage-guide)
- [Usage](#usage)
- [Credentials](#Credentials)
- [Contact](#contact)
## Project Overview
BorrowVerse is a comprehensive library management system backend with features for borrowing and managing members and books. Users borrow books, return books and check overdue books.
## Features
- **Member Management:** Create, update and delete members.
- **Book Management:** Create, update and delete books.
- **Booking Management:** Users can view the cars, book it if available.
- **Borrow and Return:** Borrow books, return books and check overdue books.
## Technologies Used
- **Backend:** Typescript, Node.js, Express
- **ORM:** Prisma
- **Database:** Postgresql
- **Deployment:** Vercel
- **Database Deployment:** Superbase
## Usage Guide
Follow the following instructions to run the application locally.
### Step 1
Open command prompt(`cmd`) in folder where you want to add the project.
### Step 2
Run the following command to clone the repository:
```bash
git clone https://github.com/rakibul58/BorrowVerse.git
```
### Step 3
Open the cloned folder or run the following in cmd:
```bash
cd BorrowVerse
```
### Step 4
In the cloned folder run the following command on cmd:
```bash
npm install
```
or
```bash
yarn install
```
### Step 5
On the root directory add a `.env` file and add your database url and other environment variables bellow:
```bash
DATABASE_URL=
# If your are using local database then DIRECT_URL is not needed
DIRECT_URL=
ENABLE_PRISMA_CACHING=false
```
### Step 6
Run the following code to start the development server:
```bash
npm run dev
```
or
```bash
yarn dev
```
### Step 7
Remove directUrl = env("DIRECT_URL") from prisma/schema.prisma
## Usage
Other commands can be found in package.json scripts. Once the application is set up and running, you can access it at http://localhost:5000 (or the appropriate port if specified differently).
## Contact
For any questions or feedback, please contact:
- **Name:** Muhammed Rakibul Hasan
- **Email:** [email protected]