An open API service indexing awesome lists of open source software.

https://github.com/abayo-luc/sneaker-city-api


https://github.com/abayo-luc/sneaker-city-api

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

        

[![Code quality](https://github.com/abayo-luc/sneaker-city-api/workflows/build/badge.svg)](https://github.com/abayo-luc/sneaker-city-api/actions) [![Test Coverage](https://api.codeclimate.com/v1/badges/b052c129ac59c84ad300/test_coverage)](https://codeclimate.com/github/abayo-luc/sneaker-city-api/test_coverage) [![Maintainability](https://api.codeclimate.com/v1/badges/b052c129ac59c84ad300/maintainability)](https://codeclimate.com/github/abayo-luc/sneaker-city-api/maintainability)

# sneaker-city-api

This the backend that powers Senakers City (BK Coding exercise).

## Getting Started

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

## Local Setup

A step by step series of examples that tell you how to get the development environment running

Clone the repo from github and install dependencies through npm.

```
git clone https://github.com/abayo-luc/sneaker-city-api.git
cd sneaker-city-api
npm install
```

### Available commands

- start the development sever: `npm run dev`
- Build production ready code: `npm run build`
- Start production server: `npm run start`
- Run test: `npm run test`

### Technologies

- NodeJS / Express
- Jest / Supertest