nodejs-api-starter

A Starter Node.js API skeleton.

Setup

Installation

1. First, click on the "Use this template" button.
2. Install all npm packages with the command:

$ npm install

Environment

You can type command:

$ cp .env.example .env

or manually create a .env file to the project root and copy/paste this default variables:

API_ENV=dev
API_VERSION=1.0.0
PORT=8000

Default packages installed

Package	Description	Docs
express	API calling and routes	https://expressjs.com/
nodemon	API rendering in Real-time	https://nodemon.io/
dotenv	Environment manager	https://www.npmjs.com/package/dotenv

Testing and development

# Run
$ npm run dev

# or run directly
$ nodemon server.js

This command will execute nodemon server.js command. For each code update, nodemon will restart automatically.

Deployment

You can deploy with Vercel: see more and check vercel.json file.

👇 Clone and Deploy now HERE by clicking here

Licence and contributing

Current licence is MIT.

You are free to modify and improve this git project.