https://github.com/educhinski/median

A back-end REST API for a blog application called Median, a Medium clone using NestJS, Prisma, PostgreSQL and Swagger
https://github.com/educhinski/median

docker nestjs postgresql prisma swagger

Last synced: about 2 months ago
JSON representation

A back-end REST API for a blog application called Median, a Medium clone using NestJS, Prisma, PostgreSQL and Swagger

• Host: GitHub
• URL: https://github.com/educhinski/median
• Owner: educhinski
• Created: 2022-08-06T18:39:04.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-24T12:43:16.000Z (almost 2 years ago)
• Last Synced: 2024-11-14T15:13:10.089Z (about 2 months ago)
• Topics: docker, nestjs, postgresql, prisma, swagger
• Language: TypeScript
• Homepage:
• Size: 1.15 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Median

## Description

A back-end REST API for a blog application called Median, a Medium clone using NestJS, Prisma ORM, PostgreSQL for database in a docker container and Swagger for documentation

## Prerequisites

This project requires [Node.js](https://nodejs.org/) and [Docker](https://www.docker.com/) to be installed. Node version ```16.15.1``` is used here.

```bash

# check if node is installed

node --version

```

## Installation

Clone the repository and install dependencies

```bash

# clone the repository

$ git clone https://github.com/educhinski/median.git

# cd into the folder

$ cd median

# install the dependencies

$ npm install

```

## Running the app

Make sure the database is running before serving the files

```bash

# run the database

$ docker compose up -d

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```

The rest api is available at 

The documentation endpoint is available at 

## Stay in touch

- Author - [Edwin Mambo](https://github.com/educhinski)

- Twitter - [@edwin_mambo](https://twitter.com/edwin_mambo)

## License

Nest is [MIT licensed](LICENSE).