README.md

Yan Odam

Yan Odam REST API with NestJS

Table of Contents

1. About The Project Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License

About The Project

Yan Odam is a REST API project with NestJS. This is the first version of Yan Odam's backend, a simple project that has a few endpoints to manage users and their roles, demonstrating the capabilities of NestJS.

Features

• Authentication /w JWT
• User Service
• House Service
• PostgreSQL Database
• Prisma ORM
• PactumJS for E2E Testing
• Socket.io for Chat

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running, follow these simple steps.

Prerequisites

• Docker

Installation

1. Run Docker on your local machine. https://www.docker.com/
2. Clone the repo.

   git clone https://github.com/emirtuncer/yanodam-api

3. Install NPM packages.

   yarn

4. Start the development environment.

   yarn start:dev

(back to top)

Usage

Run e2e tests

yarn test:e2e

Prisma Studio on test environment

npx dotenv -e .env.test -- prisma studio

(back to top)

Roadmap

• Chat with Socket.io

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)