https://github.com/samurai016/express-boilerplate

Simple boilerplate for REST API based on Express.js
https://github.com/samurai016/express-boilerplate

Last synced: 11 months ago
JSON representation

Simple boilerplate for REST API based on Express.js

• Host: GitHub
• URL: https://github.com/samurai016/express-boilerplate
• Owner: Samurai016
• Created: 2021-02-19T15:22:22.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-02-19T15:39:27.000Z (over 5 years ago)
• Last Synced: 2025-02-16T11:18:47.552Z (over 1 year ago)
• Language: JavaScript
• Size: 1.95 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Express.js boilerplate

Simple boilerplate for REST API based on Express.js.

Below there you can get an example of README for your API.

Useful links:

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

* [Express.js API Documentation](https://expressjs.com/en/api.html)

# Usage

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

* [Clone this repo](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository#cloning-a-repository-using-the-command-line) in a folder or download and unzip it from GitHub.

* Open a cmd instance (or other bash console) in this folder.

* Install Node.js dependencies using:

  ``` bash

  npm i

  ```

* Start the server using:

  ``` bash

  npm start

  ```

# Endpoints

## ![GET](https://img.shields.io/static/v1?label=%20&message=GET&color=187bdf&style=flat-square) /api/endpoint

Custom endpoint accessible via GET method.