diff --git a/README.md b/README.md index e4c58c3..3dc9f9e 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,8 @@ The Tiny URL Microservice is a simple URL shortening service built with Nest.js. - [Project Overview](#project-overview) - [Prerequisites](#prerequisites) - [Getting Started](#getting-started) - - [Using Docker Compose](#using-docker-compose) - - [Using .env File](#using-env-file) - [API Routes](#api-routes) - [Testing](#testing) -- [Contributing](#contributing) -- [License](#license) ## Project Overview @@ -31,7 +27,7 @@ Before you begin, ensure you have met the following requirements: ## 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 @@ -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 ``` - Your Nest.js server should now be running on port as like the port from the .env file. - +### Or ### 2. Using Dev Environment 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 # Shorten URL: