https://github.com/prity25-coder/book-keeping
This implementation provides a complete bookkeeping service with all the required features and endpoints.
https://github.com/prity25-coder/book-keeping
bcrypt express firestore jwt-token mongodb nodejs uuidv4
Last synced: about 1 month ago
JSON representation
This implementation provides a complete bookkeeping service with all the required features and endpoints.
- Host: GitHub
- URL: https://github.com/prity25-coder/book-keeping
- Owner: Prity25-coder
- Created: 2025-04-24T13:58:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-07T07:38:42.000Z (about 1 year ago)
- Last Synced: 2025-05-07T08:34:42.812Z (about 1 year ago)
- Topics: bcrypt, express, firestore, jwt-token, mongodb, nodejs, uuidv4
- Language: JavaScript
- Homepage:
- Size: 108 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚Book-keeping service
- This is Book-keeping inventory management for libraries backend application.
## 🐱🏍🔅🔸Features
**Authentication & Authorization:**
- Role-based access control (author, borrower, admin)
- Protected routes with middleware
- JWT based authentication
**Book Management:**
- CRUD operations for books
- Image upload to Firebase Storage
- Association with authors and libraries
**User Management:**
- Registration and login
- Different roles (author, borrower, admin)
**Library Management:**
- CRUD operations for libraries
- Inventory management
- Book assignment to libraries
**Borrowing System:**
- Borrow books with due dates and charges
- Return books
**Error Handling:**
- Custom error handling middleware
- Consistent error responses
## 🖥️📂Local Setup
### ⚙️Prerequisites
- **Node.js** and **npm** must be installed on your local machine.
- Install Node.js from [here](https://nodejs.org/)
- Install npm: `npm install `
- **MongoDB** must be installed and running on your local machine.
- Download and install MongoDB from [here](https://www.mongodb.com/try/download/compass)
### Installation Steps
1. **Clone the repository**:
```bash
git clone https://github.com/Prity25-coder/Book-Keeping.git
cd Book-Keeping
```
2. **Install dependencies** using npm:
```bash
npm install
```
3. **Set up environment variables**:
Create a `.env` file in the root of the project with the following environment variables:
```
PORT=***
MONGO_URI
```
4. **Set up MongoDB**:
- Create a database in MongoDB.
- Use Mongoose for database interaction. Ensure the database schema is set up correctly based on the model.
```bash
npm run migrate:setup
```
5. **Run the application**:
```bash
npm run start
```
6. **Access the web page**:
Open your browser and go to [http://localhost:4200](http://localhost:4200) to access the tool.
## 🌐API Reference
The API documentation is automatically generated using Swagger and can be accessed at [/api-docs] endpoint when the server is running.
###Postman collection url:-
## 🧿Deployment
[Live Demo Link](Comming Soon)