Skip to content

This is a complete project showing CRUD operation using Express js , Mongo DB and Bootstrap.

License

Notifications You must be signed in to change notification settings

umesh2407/CRUD-Project

Repository files navigation

Student Management CRUD 

This project is a simple CRUD (Create, Read, Update, Delete) API for managing a list of students. It is built using Express.js, Mongoose, and Node.js.

Table of Contents

- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
  - [Prerequisites](#prerequisites)
  - [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
- [License](#license)

Features

- Add a new student to the database
- Retrieve a list of all students
- Retrieve details of a specific student
- Update information of an existing student
- Delete a student from the database

Technologies Used

- Node.js
- Express.js
- Mongoose(MongoDB)

Getting Started

Follow these instructions to set up and run the project on your local machine.

Prerequisites

- Node.js installed on your machine
- MongoDB installed and running locally or provide a MongoDB connection string

Installation

1. Clone the repository:

   ```bash
   git clone https://github.com/your-username/student-management-crud.git
  1. Navigate to the project directory:

    cd CRUD-Project
  2. Install dependencies:

    npm install
  3. Create a .env file in the root directory and add your MongoDB connection string:

    MONGODB_URI = your_mongodb_connection_string

    Replace your_mongodb_connection_string with the actual connection string.

  4. Start the server:

    npm run dev
  5. Open your browser and visit http://localhost:3000 to test the API using a tool like Postman or curl.

Usage

[// Add instructions on how to use the API, example requests, and responses]

API Endpoints

  • GET /students: Get a list of all students
  • GET /students/:id: Get details of a specific student
  • POST /students: Add a new student
  • PUT /students/:id: Update information of an existing student
  • DELETE /students/:id: Delete a student

[// Include any additional details about the API and its endpoints]

Contributing

Contributions are welcome! Please follow the guidelines outlined in the CONTRIBUTING.md file.

License

This project is licensed under the MIT License.