Skip to content

DragonBolta/novels-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

24 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“ Novels API

A backend API for the Novel Platform, providing novel metadata and chapter retrieval.

Repository: DragonBolta/novels-api

πŸš€ Features

  • πŸ—‚ Serve novel metadata: title, author, tags, description, rating, likes
  • πŸ“‘ Retrieve chapters for novels
  • ⚑ RESTful API endpoints for frontend consumption

πŸ›  Tech Stack

  • πŸ–₯ Backend: Node.js, Express
  • πŸ’Ύ Database: MongoDB
  • 🐳 Deployment: Docker

🐳 Run with Docker (Recommended)

Pull and run the latest backend image:

# Pull the latest backend image
docker pull alvin1212/novels:api-latest

# Run the container
docker run -d -p 3000:3000 --name novels-api alvin1212/novels:api-latest

Stop and remove the container:

docker stop novels-api
docker rm novels-api

πŸ’» Local Development

To run the backend locally:

# Clone the repository
git clone https://github.com/DragonBolta/novels-api.git
cd novels-api

# Install dependencies
npm install

# Configure environment variables in a .env file (MongoDB URI, etc.)
npm start

🌐 Frontend

The API is consumed by the Novels Frontend: DragonBolta/novels-frontend

About

API for novels-frontend

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published