https://github.com/josecorreamorales/node-web-server

This is a simple web server built with Node.js and Express. It allows you to perform CRUD operations on a list of users stored in a JSON file.
https://github.com/josecorreamorales/node-web-server

express expressjs javascript nodejs rest-api

Last synced: about 2 months ago
JSON representation

This is a simple web server built with Node.js and Express. It allows you to perform CRUD operations on a list of users stored in a JSON file.

• Host: GitHub
• URL: https://github.com/josecorreamorales/node-web-server
• Owner: JoseCorreaMorales
• License: mit
• Created: 2023-08-31T15:53:48.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-09-02T18:13:18.000Z (almost 3 years ago)
• Last Synced: 2025-05-22T00:13:37.288Z (about 1 year ago)
• Topics: express, expressjs, javascript, nodejs, rest-api
• Language: JavaScript
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Node-web-server

 

 This is a simple web server built with Node.js and Express. It allows you to perform CRUD operations on a list of users stored in a JSON file.

 


 

  

 

  

  

  

  

 

 


## Installation

1. Clone the repository.

2. Install the dependencies with *`npm install`*.

3. Start the server with npm *`run dev`*.

## Usage

The server runs on http://localhost:3000. You can use any HTTP client to interact with the API. Here are the available endpoints:

* *`GET /`*: Returns a welcome message.

* *`GET /users`*: Returns a list of all users.

* *`GET /users/:id`*: Returns a single user with the given ID.

* *`POST /users`*: Creates a new user.

* *`PUT /users/:id`*: Updates a user with the given ID.

* *`DELETE /users/:id`*: Deletes a user with the given ID.

### Postman

To send parameters using Postman, follow these steps:

1. Open Postman and make sure the request is a POST method.

2. Select the "Body" tab.

3. Select "raw" and then "JSON" from the dropdown menu.

4. Enter the parameters in JSON format in the text box.

5. Click "Send" to send the request.

For example, to create a new user, you can send a POST request to *`http://localhost:3000/users`* with the following JSON in the request body:

```js

{ 

    "first_name": "Bruce",

    "last_name": "Billsberry",

    "email": "bbillsberry1m@jigsy.com"

}

```

This will create a new user with the details provided in the request body. You can verify if the user has been created successfully by sending a GET request to *`http://localhost:3000/users`*.

### Example

To create a new user, send a POST request to http://localhost:3000/users with the following JSON payload:

```json

{

        "first_name": "Skipton",

        "last_name": "Sola",

        "email": "ssola2m@last.fm"

}

```

The server will respond with a JSON object containing the new user:

```json

{

  "message": "User Created",

  "body": {

        "id": "x",

        "first_name": "Kirby",

        "last_name": "O' Shea",

        "email": "koshea2l@jigsy.com"

  }

}

```

## Resources

* [Node.js](https://nodejs.org/en/)

* [Express](https://expressjs.com/)

* [Postman](https://www.postman.com/)

* [JSON MOCK DATA](https://www.mockaroo.com/)

## License

This project is licensed under the ISC License.