LSM

LSM - an API for building a smart meter solution for lagos state government

API Documentation

The full API documentation can be found by following the link below:

Requirements and Installation

Via Cloning The Repository

# Clone the app
git clone https://github.com/vic3king/LSM.git

# Switch to directory
cd LSM

# Install Package dependencies
npm install

# create a .env file and make a clone of the .example.env
touch .env

#Start the application
npm run start:dev

#View the application
navigate to localhost:3000 to view the application

Testing

npm run test

Technologies

Backend

NodeJS is a JavaScript runtime built on Chrome's V8 JavaScript engine
Express JS A minimalist web framework
MongoDB The database for modern applications.
MongooseORM Elegant mongodb object modeling for node.js
Jest Jest is a delightful JavaScript Testing Framework with a focus on simplicity.
Supertest SuperAgent driven library for testing HTTP servers

Linter(s)

ESLint provides a pluggable linting utility for JavaScript.
Prettier Prettier is an opinionated code formatter with support for Javascript

Style Guide

Airbnb - Airbnb maintains a very popular JavaScript Style Guide

Compiler

Babel A JavaScript compiler for converting codes written in ES6 or JSX to ES5 that is supported by many browsers

Authors

Akaniru Victory - Initial work - Vic3King

See also the list of contributors who participated in this project.

vic3king / LSM

LSM