Unicornis

API Documentation

Description

unicornis is a simple and lightweight RESTful API that allows you to create and manage unicorns in a store.

Pull image and run

Pull the image from docker hub

docker pull davidokolie/unicornis:latest

Run the image

docker run --name unicornis -p 3000:3000/tcp -d davidokolie/unicornis:latest

The API should be running on http://localhost:3000/v1

Setup locally

Clone repository

git clone https://github.com/David-Inkheart/unicornis.git

Add environment variables

cp env.example .env

Request for Environment variable values and replace them in the newly created env file.

Install dependencies

Install dependencies in root and in each services folder

npm install

Running the API

To run the API locally without containerization, run the following command:

npm run dev

---

Testing

For unit tests, run npm run test

Authentication

Auth for user actions are done using bearer token

Tools/Stack

NodeJs, Express, Typescript, MongoDB, Redis, Docker, Jest