Skip to content

Latest commit

 

History

History
104 lines (63 loc) · 2.48 KB

README.md

File metadata and controls

104 lines (63 loc) · 2.48 KB
Raw

Books App Backend

This is the backend for a simple Books App, built using Node.js, Express, and MongoDB.

Books App

A simple description of your Books App goes here.

Screenshots

About Page

About Page Description: About page added 2 days ago.

Add Book

Add Book Description: Add book functionality added 2 days ago.

Delete Book

Delete Book Description: Delete book functionality added yesterday.

Home Page

Home Page Description: Home page added yesterday.

List Book

List Book Description: List book functionality added yesterday.

List Book 2

List Book 2 Description: Another view of the list book functionality added yesterday.

Update Book

Update Book Description: [Add your description here]

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

Installation

  1. Clone the repository:

    `git clone https://github.com/dxtaner/books-app-backend.git`
`cd books-app-backend`

  2. Install dependencies:

    `npm install`

  3. Set up environment variables:

    `PORT=3033             MONGODB_URI=mongodb+srv://your-username:your-password@cluster0.guofsiq.mongodb.net/books-app`

Replace your-username and your-password with your MongoDB Atlas credentials.

Usage

  1. Start the server:

    `npm start`

The server will run on http://localhost:3033 or the port specified in the .env file.

  1. Test the API:

Visit http://localhost:3033 in your browser or use tools like Postman to test API endpoints.

API Endpoints

  • GET /: Returns a welcome message.
  • GET /books: Returns a list of all books.
  • GET /books/:id: Returns details of a specific book.
  • POST /books: Creates a new book.
  • PUT /books/:id: Updates details of a specific book.
  • DELETE /books/:id: Deletes a specific book.

Contributing

Feel free to contribute to this project by opening issues or submitting pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.