https://github.com/arnobt78/mock-server--ebookstore
This repository serves as the eBookStore-ReactWebsite's mock-server backend. eBookStore is a React E-Commerce Web Application where you can place an order for codebooks. Frontend (deployed on Netlify) and Backend (deployed on Render) are separately developed here. Filter, Search Option, JSON-Server, JSON-Server-Auth, JSON Web Tokens (JWT) are used.
https://github.com/arnobt78/mock-server--ebookstore
ecommerce ecommerce-website html javascript json-api json-auth-server json-server json-web-tokens jwt-authentication netlify-deployment react react-components react-hooks react-router react-router-dom reactjs render-deployment session-storage tailwindcss
Last synced: 6 months ago
JSON representation
This repository serves as the eBookStore-ReactWebsite's mock-server backend. eBookStore is a React E-Commerce Web Application where you can place an order for codebooks. Frontend (deployed on Netlify) and Backend (deployed on Render) are separately developed here. Filter, Search Option, JSON-Server, JSON-Server-Auth, JSON Web Tokens (JWT) are used.
- Host: GitHub
- URL: https://github.com/arnobt78/mock-server--ebookstore
- Owner: arnobt78
- Created: 2024-08-31T00:55:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-29T23:03:11.000Z (6 months ago)
- Last Synced: 2025-06-29T23:28:41.293Z (6 months ago)
- Topics: ecommerce, ecommerce-website, html, javascript, json-api, json-auth-server, json-server, json-web-tokens, jwt-authentication, netlify-deployment, react, react-components, react-hooks, react-router, react-router-dom, reactjs, render-deployment, session-storage, tailwindcss
- Language: JavaScript
- Homepage: https://ebookstore-arnob.netlify.app
- Size: 68.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# eBookStore Mock Server
---
## Project Summary
The **eBookStore Mock Server** is a backend mock API server built with **Express**, **json-server**, and **json-server-auth** to simulate the eBookStore application’s backend. It provides a fully functional REST API for products, featured products, orders, and users, complete with authentication and custom access rules. This project is ideal for frontend/backend developers and learners who wish to understand API mockups, authentication, and rapid prototyping.
- **Backend Demo:** [https://codebook-mock-server-j8n3.onrender.com](https://codebook-mock-server-j8n3.onrender.com)
- **Frontend Demo:** [https://ebookstore-arnob.netlify.app](https://ebookstore-arnob.netlify.app)
- **Frontend Source:** [https://github.com/arnobt78/eBookStore--ReactJS](https://github.com/arnobt78/eBookStore--ReactJS)
---
## Table of Contents
1. [Project Structure](#project-structure)
2. [Features](#features)
3. [Technology Stack](#technology-stack)
4. [Installation](#installation)
5. [How to Run](#how-to-run)
6. [API Endpoints](#api-endpoints)
7. [Authentication & Access](#authentication--access)
8. [Example Data & Scripts](#example-data--scripts)
9. [Learning & Teaching Notes](#learning--teaching-notes)
10. [Conclusion](#conclusion)
---
## Project Structure
```
.
├── .gitignore
├── data/
│ ├── db.json
│ └── routes.json
├── index.js
├── package.json
```
- **.gitignore**: Specifies files/folders to ignore in Git.
- **data/db.json**: Stores mock data for products, featured products, orders, and users.
- **data/routes.json**: Custom route rules for the API.
- **index.js**: Main entry point; configures and starts the Express server, JSON server, and authentication.
- **package.json**: Project metadata, dependencies, and scripts.
View the project files directly for more details:
- [db.json](https://github.com/arnobt78/Mock-Server--eBookStore/blob/main/data/db.json)
- [routes.json](https://github.com/arnobt78/Mock-Server--eBookStore/blob/main/data/routes.json)
- [index.js](https://github.com/arnobt78/Mock-Server--eBookStore/blob/main/index.js)
- [package.json](https://github.com/arnobt78/Mock-Server--eBookStore/blob/main/package.json)
---
## Features
- **Full REST API** for eBookStore entities (products, featured_products, orders, users)
- **Authentication & Authorization** using `json-server-auth` (configurable access levels)
- **Custom Routing** via `routes.json`
- **CORS** enabled for easy frontend integration
- **Mock Data** for learning, prototyping, and frontend development
- **Easy Extensibility** for new resources or routes
---
## Technology Stack
- **Node.js**: Server runtime
- **Express**: Core server framework
- **json-server**: Rapid REST API mock server
- **json-server-auth**: Simple authentication/authorization layer for `json-server`
---
## Installation
### Prerequisites
- Node.js installed ([Download Node.js](https://nodejs.org/))
- npm (Node Package Manager)
### Steps
1. **Clone the Repository:**
```sh
git clone
cd Mock-Server--eBookStore
```
2. **Install Dependencies:**
```sh
npm install
```
---
## How to Run
Start the server with:
```sh
npm start
```
- By default, the server runs on: [http://localhost:8000](http://localhost:8000)
---
## API Endpoints
All endpoints are prefixed with `/api`:
- `GET /api/products` — Fetch all products
- `GET /api/featured_products` — Fetch all featured products
- `GET /api/orders` — Fetch all orders
- `GET /api/users` — Fetch all users
**Custom routes** and access rules are defined in [`data/routes.json`](https://github.com/arnobt78/Mock-Server--eBookStore/blob/main/data/routes.json):
```json
{
"/products*": "/444/",
"/featured_products*": "/444/",
"/orders*": "/660/",
"/users*": "/600/"
}
```
---
## Authentication & Access
Authentication is handled via `json-server-auth` and rules are set in `index.js`:
```javascript
const rules = auth.rewriter({
products: 444, // Read-only
featured_products: 444, // Read-only
orders: 660, // Read & Write
users: 600 // Full access
});
```
- `444` = Read-only access
- `660` = Read and write access
- `600` = Full access (CRUD)
**Authentication Example:**
To access protected routes, you must register/login and use the provided token.
---
## Example Data & Scripts
### Example Product (`db.json`)
```json
{
"products": [
{
"id": 10001,
"name": "Basics To Advanced In React",
"overview": "Lorem ipsum dolor sit amet consectetur adipisicing elit. Error unde quisquam magni vel eligendi nam.",
"long_description": "Lorem ipsum dolor sit amet consectetur, adipisicing elit. Soluta aut, vel ipsum maxime quam quia, quaerat tempore minus odio exercitationem illum et eos, quas ipsa aperiam magnam officiis libero expedita quo voluptas deleniti sit dolore? Praesentium tempora cumque facere consectetur quia, molestiae quam, accusamus eius corrupti laudantium aliquid! Tempore laudantium unde labore voluptates repellat, dignissimos aperiam ad ipsum laborum recusandae voluptatem non dolore. Reiciendis cum quo illum. Dolorem, molestiae corporis.",
"price": 29,
"poster": "https://images.unsplash.com/photo-1633356122544-f134324a6cee?ixlib=rb-1.2.1&auto=format&fit=crop&w=650&q=40",
"image_local": "/assets/images/10001.avif",
"rating": 5,
"in_stock": true,
"size": 5,
"best_seller": true
}
// More products...
]
}
```
> For more, see [`data/db.json`](https://github.com/arnobt78/Mock-Server--eBookStore/blob/main/data/db.json)
---
## Learning & Teaching Notes
- **Purpose:** This project is designed as a learning tool for developers to understand how to mock REST APIs, use authentication, and simulate a real backend for frontend development.
- **Modular Structure:** Easily add more entities or extend existing data.
- **Security:** Shows how to implement and test route protection in a mock server context.
- **Frontend Integration:** Works perfectly with any frontend (React, Angular, Vue, etc.) — just use the `/api` endpoints.
- **Customization:** Data, routes, and access rules can be easily edited for different scenarios.
---
## Full Code Example: Server Setup (`index.js`)
```javascript
import express from "express";
import jsonServer from "json-server";
import auth from "json-server-auth";
const server = express();
server.use((req, res, next) => {
res.header('Access-Control-Allow-Origin', '*');
res.header('Access-Control-Allow-Headers', '*');
next();
});
const router = jsonServer.router('./data/db.json');
server.use('/api', router);
server.db = router.db;
const middlewares = jsonServer.defaults();
const rules = auth.rewriter({
products: 444,
featured_products: 444,
orders: 660,
users: 600
});
server.use(rules);
server.use(auth);
server.use(middlewares);
server.use(router);
server.listen(8000);
```
---
## Keywords
`express`, `json-server`, `mock api`, `authentication`, `json-server-auth`, `REST`, `node.js`, `eBookStore`, `api prototyping`, `learning`, `teaching`, `backend`, `routes`, `middleware`, `mock data`, `CORS`
---
## Conclusion
The **eBookStore Mock Server** is a robust and easy-to-use mock backend for learning, teaching, and rapid prototyping. With real-world structure and authentication, it empowers developers to quickly test and demo frontend applications without building a full backend. Customize the data, routes, and rules as needed — and start building today!
---