Skip to content

Latest commit

 

History

History
84 lines (63 loc) · 2.27 KB

README.md

File metadata and controls

84 lines (63 loc) · 2.27 KB
Raw

Node.js API with PostgreSQL

This is a simple RESTful API built with Node.js and Express, designed to interact with a PostgreSQL database. The API provides endpoints for managing user data.

Features

  • Get All Users: Retrieve a list of all users.
  • Get User by ID: Retrieve a specific user by their ID.
  • Create User: Add a new user to the database.
  • Update User: Update details of an existing user.
  • Delete User: Remove a user from the database.

Technologies Used

  • Node.js
  • Express
  • PostgreSQL
  • Body-parser

Installation

  1. Clone the repository:

    git clone https://github.com/JawherKl/node-api-postgres.git
cd node-api-postgres

  2. Install dependencies: bash npm install

  3. Set up PostgreSQL: Ensure you have PostgreSQL installed and running. Create a database and a users table as per your requirements.

  4. Configure Database Connection: Update the queries.js file to set up your PostgreSQL connection

Usage

Start the server:

node index.js

The server will run on [http://localhost:3000].

API Endpoints:

. GET / - Returns a simple welcome message.
. GET /users - Returns all users.
. GET /users/:id - Returns a user by ID.
. POST /users - Creates a new user (requires JSON body).
. PUT /users/:id - Updates an existing user by ID (requires JSON body).
. DELETE /users/:id - Deletes a user by ID.

Example Requests

Get All Users

 curl -X GET http://localhost:3000/users

Create User

curl -X POST http://localhost:3000/users -H "Content-Type: application/json" -d '{"name": "John Doe", "email": "[email protected]"}'

Update User

curl -X PUT http://localhost:3000/users/1 -H "Content-Type: application/json" -d '{"name": "Jane Doe"}'

Delete User

curl -X DELETE http://localhost:3000/users/1

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.

License

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

Acknowledgments

  • Thanks to the contributors and the open-source community for their support.
  • Special thanks to the maintainers of the libraries used in this project.