Skip to content
This repository has been archived by the owner on Feb 26, 2021. It is now read-only.

An easily modifiable and modular Node.JS API with minimal/no dependencies making it easy to use and learn with! The code is quite messy, I do apologise

License

Notifications You must be signed in to change notification settings

dudeisbrendan03/RESTful-api

Repository files navigation

v0.3.308

Get the docs

Check DevOps

Another RESTful API

What is this

A Node.JS based API that also functions as content delivery. It's main purpose is to provide authentication/ACL and also to deliver content like websites and application/* data

This is going to be used for an application I'm currently making.

Setup

View deployment instructions

Usage

The application can be launched in multiple environment modes (this is still a WIP, going to introduce features into each environment like security features etc)

Using an environment: NODE_ENV=env-name node.

The current env-name's in the project are:

  • production (123.456.789.012:80/443)
  • staging (0.0.0.0:8080/8081)
  • tokClear (clears expired tokens)

If there is no environment defined when starting the application then it defaults to staging.

To clear expired tokens while the server is running run: NODE_ENV=tokClear node .

Errors

Learn about error and their meaning here

Dependancies

None(ish)!

We have no imports, no need for a package.json or any dependacy management. But this DOES require Node 8.*.

Credits

Credits file

About

An easily modifiable and modular Node.JS API with minimal/no dependencies making it easy to use and learn with! The code is quite messy, I do apologise

Resources

License

Security policy

Stars

Watchers

Forks