Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.67 KB

README.md

File metadata and controls

43 lines (27 loc) · 1.67 KB

Build Status codecov

Hackerbay Backend Challenge

Features

  • User login.
  • Thumbnail creation (50x50) from image url.
  • Json patching.

Installation and setup

  • Clone this repository by running: $ git clone https://github.com/otseobande/hackerbay-backend.git
  • Navigate to into the project folder: cd hackerbay-backend
  • Install dependencies by running: $ npm install
  • Start the development server by running: $ npm run start:dev
  • All is set. You should be able to access the application via localhost:8000

Testing

To test the application simply run: $ npm run test

Docker

Docker hub repo: Link

To use the application's docker image. Follow the following steps:

  • Download and install docker
  • Login using: $ docker login
  • Pull the application image: $ docker pull otseobande/hackerbay-backend
  • Run the image in container: $ docker run -p 8000:8000 otseobande/hackerbay-backend:latest
  • The application should be accessible via localhost:8000

And you're good to go!

API documentation

All endpoints are documented using postman. Checkout the published documentation.

Project management

This project is managed with Pivotal Tracker. Here's a link to the story board: PT board.