Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ejiroosiephri/stackron-task-solution


https://github.com/ejiroosiephri/stackron-task-solution

Last synced: 15 days ago
JSON representation

Awesome Lists containing this project

README

        

# STACKRON

## Features

- Written in typescript
- Supports all Github-supported
- Works on Mac, Linux and Windows
- Supports other version control systems

## Installation

```bash/Powershell
$ fork the repository if you want
$ git clone https://github.com/EjiroOsiephri/Stackron-task-solution.git
$ create a .env and add a PORT=8000 (optional)
$ npm install
```
$ in the root directory run the command `npm run dev` to start the server and the database.
```
$ You should see something like this Server is running on http://localhost:8000 & Database synchronized successfully in your terminal or
$ go to [server](http://localhost:8000) a message will be displayed `Welcome to stackron ecommerce!`
```

## TEST

check out [swagger](http://localhost:8000/docs)

do this only after the server is running.

## Documentation

```
$ in the root directory run the command `npm test` to start jest --watch or npm test:coverage for better log.
```