Giter Club home page Giter Club logo

mantrckr's Introduction

mantrckr Build Status Maintainability Coverage Status

A maintainence tracker application used by users to file maintenance requests and watch the progress of the request.

Getting Statrted

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Having the following installed on your local machine and an even basic knowledge of their usage would make running/testing this project a breeze for you:

- NodeJs (This project was built on Node v8.11.1)
- ExpressJs
- Postman (for testing the API)
- Chai + chai-http (assertion library for tests)
- Git

Installing

Grab a copy of the repo to your local machine by running:

$ git clone https://github.com/akhilome/mantrckr.git

After cloning, cd into the project directory:

$ cd mantrckr

Install packages

$ npm install

To start the server run

$ npm start

Once the server is running locally, you can access the app on any browser on your local machine by visiting localhost:3000

You can stop the server anytime from bash by hitting CTRL + C on your keyboard

Running the tests

To run the tests, use

npm test

Deployment

You can see how the UI looks by visiting Github Page or access the API on Heroku.

Built With

Author

Acknowlegments

Hat tip to:

  • Andela for giving me this project to learn with,
  • my week 1 LFA (Temitope Emmanuel) for the constructive feedback, and encouragement to push forward,
  • the genius who provided an awesome README template to follow,
  • Ahmed Omonsanya for the 'guidiance' ;)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.