/app-deploy-node

Primary LanguageJavaScriptGNU Lesser General Public License v3.0LGPL-3.0

NodeJS REST API SQLite

This project is a proof of concept (POC).
It's purpose is to demonstrate an implementation of a NodeJS REST API using SQLite as a database (sqlite.db).
The code is written in ES6 and uses Promises.

Installation :

  1. Clone this repository : git clone https://github.com/romwaldtff/NodeJS-REST-API-SQLite.git
  2. Then install its dependencies : npm install

Requirements :

  • Git if you want to clone this repository.
  • NodeJS to run the application.
  • Npm to install dependencies (see the full list below at "Dependencies").
  • Postman to test the API.

Getting started :

  1. Install this application (See Installation).
  2. Start the server with : node index.js
  3. Connect Postman to the API at : http://localhost:3000
  4. Try the different routes of the API (For more details, see the documentation).

Alternatively, you can use node index.js YOUR_PORT_NUMBER to start the server with a specific port.

Dependencies (installed via npm install)

  • Body-parser, a Node.js body parsing middleware.
  • Ejs embedded JavaScript templates.
  • Express, a fast and minimalist web framework for node.
  • Sqlite, a wrapper library that adds ES6 promises and SQL-based migrations API to sqlite3*.
  • Bluebird promise library.

Credits

License

This project uses the LGPL v3 License (See the LICENSE file in this repository).