Skip to content

README.md

Latest commit

 

History

History
55 lines (38 loc) · 940 Bytes

README.md

File metadata and controls

55 lines (38 loc) · 940 Bytes
Raw

Student Management API

A simple Node.js and PostgreSQL API for managing student records.

Project Structure

Installation

  1. Clone the repository:

    git clone https://github.com/capwell-murimi/NODE_REST_API.git
cd NODE_REST_API

  2. Install dependencies:

    npm install

  3. Configure the database connection in db.js:

    const pool = new Pool({
     user: 'your_username',
     host: 'your_host',
     database: 'your_database',
     password: 'your_password',
     port: 5432 // Change if needed
});

  4. Start the server:

    node server.ja

API Endpoints

  • GET /api/v1/students - Retrieve students

Technologies Used

  • Node.js (Express.js)
  • PostgreSQL (pg library)

License

This project is open-source. Feel free to modify and contribute!! 🚀