Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jornatf/nodejs-api-starter
A Starter Node.js API skeleton.
https://github.com/jornatf/nodejs-api-starter
api api-node api-nodejs api-rest node node-js nodejs nodejs-express nodejs-server
Last synced: about 2 months ago
JSON representation
A Starter Node.js API skeleton.
- Host: GitHub
- URL: https://github.com/jornatf/nodejs-api-starter
- Owner: jornatf
- Created: 2023-11-20T10:01:52.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-01-11T15:13:31.000Z (12 months ago)
- Last Synced: 2024-01-28T14:41:01.188Z (11 months ago)
- Topics: api, api-node, api-nodejs, api-rest, node, node-js, nodejs, nodejs-express, nodejs-server
- Language: JavaScript
- Homepage: https://nodejs-api-starter.vercel.app
- Size: 5.86 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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:
```bash
$ npm install
```
### Environment
You can type command:
```bash
$ 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/](https://expressjs.com/) |
| **nodemon** | API rendering in Real-time | [https://nodemon.io/](https://nodemon.io/) |
| **dotenv** | Environment manager | [https://www.npmjs.com/package/dotenv](https://www.npmjs.com/package/dotenv) |
## Testing and development
```bash
# 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](https://vercel.com/) and check `vercel.json` file.
👇 Clone and Deploy now HERE by clicking here
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fjornatf%2Fnodejs-api-starter)
## Licence and contributing
Current licence is `MIT`.
**You are free to modify and improve this git project.**