angleu/kissalu-api

Kisalu Server Side

Kisalu's back-end readme file
Explore the front-end repo »

Report Bug · Request Feature

---

Tech Stack

Express JS · Socket Io · Prisma · JWT · TypeScript

---

Requirements

• Node JS 16.X
• Docker

Local Development

First of all, install the dependencies using the command below

npm install

Setup the environment

Create a .env file in the root with the following structure

DATABASE_URL="postgresql://postgres:docker@localhost:5432/kisalu_local?schema=public"

MONGO_URL = "mongodb://kisalu_mongo:[email protected]:27017/admin"

SECRET= "30b9dce7-08c2-4c22-8204-b9e41d624ab9"

SOCKETS_NAMESPACE = "Kisalu"

Make sure you have docker installed, then run

# This command will pull images (if not pulled yet) and iniate docker containers
docker-compose up -d

# Show all running containers
docker ps

Once all images have been installed and started running, execute the command

# This command will create the whole data base structure based on the schema.prisma file
npm run migrate-dev

Live Test

Use the command below to start the server

npm run dev

Checkout the API's documentation (interactive)

http://localhost:8080/api/doc

Unit Tests

npm test

Local Data Base

Relational

To interact with the data base use (recommended) open-source clients such as:

• BeeKeeper Studio
• DBeaver

Or, run the following command

npm run data-base

Non-Relational

Open the following link to access Mongo-Express interface

http://localhost:8081