Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dimaskiddo/codebase-nodejs-rest
Codebase for REST API in NodeJS
https://github.com/dimaskiddo/codebase-nodejs-rest
api codebase js nodejs rest server
Last synced: 7 days ago
JSON representation
Codebase for REST API in NodeJS
- Host: GitHub
- URL: https://github.com/dimaskiddo/codebase-nodejs-rest
- Owner: dimaskiddo
- Created: 2019-02-19T09:54:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-08-24T06:25:19.000Z (about 1 year ago)
- Last Synced: 2023-08-24T07:41:41.083Z (about 1 year ago)
- Topics: api, codebase, js, nodejs, rest, server
- Language: JavaScript
- Homepage:
- Size: 336 KB
- Stars: 10
- Watchers: 0
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Codebase for REST API in NodeJS
This codebase help a new NodeJS developer in developing a REST API using NodeJS.
This codebase included with some pre bundle service or helper like authentication, logging, and predefined configuration.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Prequisites package:
* NodeJS (NodeJS Programming Language) Version 8.xx or higher
* NPM (NodeJS Dependency Package Management Tool) Version 5.xx or higher
Optional package:
* Docker (Application Containerization)
### Installing
Below is the instructions to make this codebase running:
* Pull the codebase from this repository
```
git clone -b master https://github.com/dimaskiddo/codebase-nodejs-rest.git
cd codebase-nodejs-rest
```
* Remove any related git configuration
```
rm -rf .git
```
* Run following command to pull dependecies package
```
npm install
```
- Until this step you already can run this code by using this command
```
npm start
```
## Running The Tests
Currently the test is not ready yet :)
## Deployment
**Make sure your your js script does not relate to github.com/dimaskiddo/codebase-nodejs-rest anymore**.
To build this codebase to binaries for distribution purposes you can use any external NodeJS builder like [pkg](https://github.com/zeit/pkg)
## Built With
* [NodeJS](https://nodejs.org/) - NodeJS Programming Languange
* [NPM](https://www.npmjs.com/) - NodeJS Dependency Package Management Tool
* [Docker](https://www.docker.com/) - Application Containerization
## Authors
* **Dimas Restu Hidayanto** - *Initial Work* - [DimasKiddo](https://github.com/dimaskiddo)
See also the list of [contributors](https://github.com/dimaskiddo/codebase-nodejs-rest/contributors) who participated in this project
## Annotation
You can seek more information for the npm command parameters in the [package.json](https://raw.githubusercontent.com/dimaskiddo/codebase-nodejs-rest/master/package.json)