"Basic API" is an opinionated implementation of a Web API Application, now we implement Express.JS in Node.JS, where we wants an application that could become in a template of another projects.
If you see any opportunities to enhance this project, please don't hesitate to submit a issue with your proposed changes. For information on how to contribute.
Please refer to the environment example before running this application.
For developer information, go here. You can navigate src folder, and check the readme files inside.
- This Application was thought to run in a gnu/linux machine.
- Develop using Node.JS in current version, we recommend install using this version or latest LTS version (Long Term Support) and latest of package manager version.
# First Clone the repo
git clone https://github.com/cris-mur/basicapi.git
cd basicapi
# then Install Project dependencies, in this case with npm
npm i
# Copy Environment example in environment file
cat ./env.example > .env
# use npm to start the application
npm run startMainly we wanted that this application can be configured using the environment variables, cause we feel set some var using a file is more comfortable than modifying the source code to able or disable features.
To setup the application behavior for example, change which request parser the application can use, change his settings, or set another features, we recommend use the example file to start.
### NODE SPACE
# NODE_ENV="production" # "development"
#############################################################
### LOGGER OPTIONS
# LOGGER=true
# VERBOSE=true
# COLORED=true
#############################################################
##################### HOMEBREW FEATURES #####################
#############################################################
### Inspector
# INSPECTOR=true
#############################################################
### Error 404 & 5XX Handlers
# ERRORS_HANDLERS=true
### NETWORK SETTINGS
# SERVERLESS=true
# RESILIENT_PORT=true
# PORT=2700
# PORT_DEV=2701
#############################################################
##################### EXPRESS FEATURES ######################
#BUILD_IN_FEATURES=true
# DISSABLE_POWERED_BY=true
#############################################################
### JSON PARSER OPTIONS
# JSON=true
.
.
.in case that you start application without Environment file, the application will use the example file to startup. (and it fails, the applications will runs in default mode)
- Please check package.json file to more information.
$ npm run start
> [email protected] start
> ./src/bin/init
▄▄▄▄ ▄▄▄ ██████ ██▓ ▄████▄ ▄▄▄ ██▓███ ██▓
▓█████▄ ▒████▄ ▒██ ▒ ▓██▒▒██▀ ▀█ ▒████▄ ▓██░ ██▒▓██▒
▒██▒ ▄██▒██ ▀█▄ ░ ▓██▄ ▒██▒▒▓█ ▄ ▒██ ▀█▄ ▓██░ ██▓▒▒██▒
▒██░█▀ ░██▄▄▄▄██ ▒ ██▒░██░▒▓▓▄ ▄██▒ ░██▄▄▄▄██ ▒██▄█▓▒ ▒░██░
░▓█ ▀█▓ ▓█ ▓██▒▒██████▒▒░██░▒ ▓███▀ ░ ▓█ ▓██▒▒██▒ ░ ░░██░
░▒▓███▀▒ ▒▒ ▓▒█░▒ ▒▓▒ ▒ ░░▓ ░ ░▒ ▒ ░ ▒▒ ▓▒█░▒▓▒░ ░ ░░▓
▒░▒ ░ ▒ ▒▒ ░░ ░▒ ░ ░ ▒ ░ ░ ▒ ▒ ▒▒ ░░▒ ░ ▒ ░
░ ░ ░ ▒ ░ ░ ░ ▒ ░░ ░ ▒ ░░ ▒ ░
░ ░ ░ ░ ░ ░ ░ ░ ░ ░
░ ░
[ white ][ development ][ 2024-03-02T00:08:24.735Z ][ log ]
Startup: 62.125ms
[ white ][ development ][ 2024-03-02T00:08:24.738Z ][ log ]
Application process id: 11803
[ white ][ development ][ 2024-03-02T00:08:24.738Z ][ log ]
Listening on port 33047
http://localhost:33047
http://white:33047
-----------
$ npm run dev
> [email protected] dev
> npx nodemon ./src/bin/init
[nodemon] 3.1.0
[nodemon] to restart at any time, enter `rs`
[nodemon] watching path(s): *.*
[nodemon] watching extensions: js,mjs,cjs,json
[nodemon] starting `node ./src/bin/init`
▄▄▄▄ ▄▄▄ ██████ ██▓ ▄████▄ ▄▄▄ ██▓███ ██▓
▓█████▄ ▒████▄ ▒██ ▒ ▓██▒▒██▀ ▀█ ▒████▄ ▓██░ ██▒▓██▒
▒██▒ ▄██▒██ ▀█▄ ░ ▓██▄ ▒██▒▒▓█ ▄ ▒██ ▀█▄ ▓██░ ██▓▒▒██▒
▒██░█▀ ░██▄▄▄▄██ ▒ ██▒░██░▒▓▓▄ ▄██▒ ░██▄▄▄▄██ ▒██▄█▓▒ ▒░██░
░▓█ ▀█▓ ▓█ ▓██▒▒██████▒▒░██░▒ ▓███▀ ░ ▓█ ▓██▒▒██▒ ░ ░░██░
░▒▓███▀▒ ▒▒ ▓▒█░▒ ▒▓▒ ▒ ░░▓ ░ ░▒ ▒ ░ ▒▒ ▓▒█░▒▓▒░ ░ ░░▓
▒░▒ ░ ▒ ▒▒ ░░ ░▒ ░ ░ ▒ ░ ░ ▒ ▒ ▒▒ ░░▒ ░ ▒ ░
░ ░ ░ ▒ ░ ░ ░ ▒ ░░ ░ ▒ ░░ ▒ ░
░ ░ ░ ░ ░ ░ ░ ░ ░ ░
░ ░
[ white ][ development ][ 2024-03-02T00:10:10.299Z ][ debug ]
[ JSON OPTIONS ] {"inflate":false,"limit":"100kb","strict":false,"type":"application/json","reviver":null}
[ white ][ development ][ 2024-03-02T00:10:10.414Z ][ debug ]
StartUp Application
[ white ][ development ][ 2024-03-02T00:10:10.415Z ][ debug ]
[locals vars] {}
[ white ][ development ][ 2024-03-02T00:10:10.417Z ][ debug ]
[Swagger mount] /api
[ white ][ development ][ 2024-03-02T00:10:10.462Z ][ debug ]
[middlewares to load] {
_json: [Function: jsonParser],
_raw: undefined,
_static: [Function: serveStatic],
_text: undefined,
_urlencoded: undefined,
_cors: undefined
}
[ white ][ development ][ 2024-03-02T00:10:10.463Z ][ debug ]
[loading middleware] _json [Function: jsonParser]
[ white ][ development ][ 2024-03-02T00:10:10.464Z ][ debug ]
[loading middleware] _static [Function: serveStatic]
[ white ][ development ][ 2024-03-02T00:10:10.464Z ][ debug ]
[_static middleware path] /
[ white ][ development ][ 2024-03-02T00:10:10.467Z ][ debug ]
[one instance of application ready]
[ white ][ development ][ 2024-03-02T00:10:10.467Z ][ debug ]
[End of StartUp application ready]
[ white ][ development ][ 2024-03-02T00:10:10.468Z ][ log ]
Startup: 53.054ms
[ white ][ development ][ 2024-03-02T00:10:10.469Z ][ log ]
Application process id: 11962
[ white ][ development ][ 2024-03-02T00:10:10.469Z ][ log ]
Listening on port 6661
http://localhost:6661
http://white:6661made with love by -
Cristian Murcia
