kfir/tiny-url-nestjs-microservice
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

README.md

Browse source
This commit is contained in:
Kfir Dayan 2024-01-22 15:51:29 +02:00
parent 624357b536
commit 1c72e3b403
1 changed files with 5 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -7,12 +7,8 @@ The Tiny URL Microservice is a simple URL shortening service built with Nest.js.
- [Project Overview](#project-overview) - [Project Overview](#project-overview)
- [Prerequisites](#prerequisites) - [Prerequisites](#prerequisites)
- [Getting Started](#getting-started) - [Getting Started](#getting-started)
- [Using Docker Compose](#using-docker-compose)
- [Using .env File](#using-env-file)
- [API Routes](#api-routes) - [API Routes](#api-routes)
- [Testing](#testing) - [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Project Overview ## Project Overview
@ -31,7 +27,7 @@ Before you begin, ensure you have met the following requirements:
## Getting Started ## Getting Started
To get the project up and running,Choose one of the options and follow the instructions below. To get the project up and running, Choose one of the options and follow the instructions below.
### 1. Using Docker Compose ### 1. Using Docker Compose
@ -39,14 +35,16 @@ To get the project up and running,Choose one of the options and follow the instr
docker-compose -f docker-compose.yaml up -d --build docker-compose -f docker-compose.yaml up -d --build
``` ```
Your Nest.js server should now be running on port as like the port from the .env file. ### Or
### 2. Using Dev Environment ### 2. Using Dev Environment
run `npm run start:dev` to start the server. run `npm run start:dev` to start the server.
### Your Nest.js server should now be running on port as like the port from the .env file.
## API Routes ## API Routes
# Shorten URL: # Shorten URL: