https://github.com/yasharthbajpai/books_api
This repository contains a full-stack book management application built with Node.js, Express.js, MongoDB, React, and Docker. It features JWT-based authentication, CRUD operations, and is fully dockerized for seamless deployment.
https://github.com/yasharthbajpai/books_api
api crud docker javascript jwt-token mongodb
Last synced: 2 months ago
JSON representation
This repository contains a full-stack book management application built with Node.js, Express.js, MongoDB, React, and Docker. It features JWT-based authentication, CRUD operations, and is fully dockerized for seamless deployment.
- Host: GitHub
- URL: https://github.com/yasharthbajpai/books_api
- Owner: yasharthbajpai
- License: mit
- Created: 2025-03-30T07:05:59.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-30T09:17:07.000Z (2 months ago)
- Last Synced: 2025-03-30T09:22:40.710Z (2 months ago)
- Topics: api, crud, docker, javascript, jwt-token, mongodb
- Language: JavaScript
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Books API
A RESTful API for managing books with user authentication using Express.js, MongoDB, JWT, and Dockerization.
## Features
- User authentication (register, login, logout)
- JWT-based authentication with token storage
- Book management (CRUD operations)
- Advanced filtering and search functionality
- Sorting capabilities by price and rating
- Pagination for handling large datasets
- MongoDB database integration
- Modular code structure
- **Dockerized setup for streamlined deployment**
## Demo Links
**Backend Demo:** [Backend Demo](https://drive.google.com/file/d/1c5clbMfZH1PgJnHiWnGrdXJ_0CVOq9uh/view?usp=sharing)
**Docker Demo:** [Docker Demo](https://drive.google.com/file/d/1tZ6ipH8vY5Vax_Ur_pDo5VKUy-QMtdSF/view?usp=sharing)
**Docker Repository:** [Docker Hub Repository](https://hub.docker.com/repository/docker/lolatolopa/zynetic_bda/general)
## Tech Stack
- Node.js
- Express.js
- MongoDB with Mongoose
- JSON Web Tokens (JWT)
- Cors
- Docker
## Project Structure
```
├── schemas/ # MongoDB schema models (books.js, tokens.js, users.js)
├── src/
│ ├── controllers/ # Route controllers
│ ├── db/ # Database connection
│ ├── middleware/ # Express middleware
│ ├── routes/ # API routes
│ └── server.js # Server entry point
├── frontend/ # React frontend application
├── .dockerignore # Docker ignore file
├── Dockerfile # Docker build instructions
├── docker-compose.yml # Docker Compose configuration
├── .env # Environment variables (create from .env.example)
├── .gitignore # Git ignore file
├── package.json # Project dependencies
└── README.md # Project documentation
```
## API Endpoints
### Authentication
- **Register a User**
- POST `/register`
- Body: `{ "name": "string", "email": "string", "password": "string" }`
- **Login**
- POST `/login`
- Body: `{ "email": "string", "password": "string" }`
- Returns: JWT token
- **Logout**
- POST `/logout`
- Headers: `Authorization: Bearer `
### Books
All book endpoints require authentication (JWT token in Authorization header).
- **Create a Book**
- POST `/createbook`
- Body: `{ "title": "string", "author": "string", "category": "string", "price": number, "rating": number, "publishedDate": "Date" }`
- **Get All Books**
- GET `/getbooks`
- Query params:
- `page`: Page number (default: 1)
- `limit`: Items per page (default: 10)
- `sortBy`: Field to sort by ('price' or 'rating')
- `order`: Sort order ('asc' or 'desc')
- Returns: Books array with pagination metadata
- **Get Book by ID**
- GET `/getbook/:id`
- **Update Book**
- PATCH `/updatebook/:id`
- Body: `{ "title": "string", ... }` (fields to update)
- **Delete Book**
- DELETE `/deletebook/:id`
- **Filter Books**
- GET `/filterbooks`
- Query params:
- `author`: Filter by author name.
- `category`: Filter by category.
- `minRating`: Filter by minimum rating.
- Returns: Filtered books array.
- **Search Books**
- GET `/searchbooks`
- Query params:
- `title`: Search term for book title (partial match).
- Returns: Books matching the search term.
### Health Check
- **Server Health**
- GET `/health`
## Getting Started
### Prerequisites
- Node.js (v14 or higher)
- MongoDB (local or Atlas)
- Docker and Docker Compose
### Installation
1. Clone the repository:
```bash
git clone https://github.com/yourusername/express-book-api.git
cd express-book-api
```
2. Install dependencies:
```bash
npm install
```
3. Create a `.env` file based on `.env.example`:
```bash
cp .env.example .env
```
4. Update the `.env` file with your MongoDB connection URI and secret key.
### Running the Application
#### Development mode (with auto-restart):
```bash
npm run dev
```
#### Production mode:
```bash
npm start
```
#### Using Docker:
1. Build and run the containers:
```bash
docker-compose up --build
```
2. Access the API at `http://localhost:`.
## Frontend Application
The project includes a complete frontend application built with React. For details, see the [frontend README](./frontend/README.md).
Key frontend features:
- Mobile app-like UI with dark violet theme.
- Authentication flows (login/register).
- Book browsing with sorting and filtering.
- Search functionality.
- Responsive design.
To run the frontend:
```bash
cd frontend
npm install
npm run dev
```
**Full Frontend Demo:** [Full Frontend Demo](https://drive.google.com/file/d/15jMWHTbk-AwYcbOC4NtJUCFq7hOy4bJe/view?usp=sharing)
## License
This project is licensed under the [MIT](LICENSE) license.
## Author
Made by Yasharth Bajpai.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.