This repository contains the back-end submission of a 3rd year final year project demonstrating a Professional Practise in IT and a well structured, easy-to-use RESTful web server.
The server runs using Node.js and is written in Typescript using Restify. Restify borrows heavily from Express however does not provide the ability of server template files.
Development workflow is managed using npm scripts. The Typescript source is contained in the src directory and transpiled to lib - where PM2-dev is used as a process manager to allow live reloading of the server if changes and made and saved. The script will clean the lib directory where the server is running, rebuild the files using the Typescript compiler and restart the server - making for a smooth development workflow without having to manually restart the server when changes have been made.
Neo4j is used the current database for the server and can be installed by following the simple instructions in the link provided below.
A detailed design document is contained in the front-end respository which consumes this API and can be found HERE!
A sample database has been provided to use with Neo4j. Simply unzip the file named restify-db and launch it using Neo4j. The password for the sample database provided is: password.
npm install -g pm2@latest bunyan
npm install
npm run watch
As it stands the API provides only one test - Healthcheck. The server provides a basic healthcheck test for verifying that the /healthcheck route is a live and working. A future improvement for the server is to have to test for all pieces of functionality.
Tests are currently carried out using Mocha, Chai and Supertest.
npm run test