README.md
This commit is contained in:
parent
6513fd2aed
commit
624357b536
1 changed files with 4 additions and 10 deletions
14
README.md
14
README.md
|
@ -31,26 +31,20 @@ Before you begin, ensure you have met the following requirements:
|
||||||
|
|
||||||
## Getting Started
|
## Getting Started
|
||||||
|
|
||||||
To get the project up and running, follow the instructions below.
|
To get the project up and running,Choose one of the options and follow the instructions below.
|
||||||
|
|
||||||
### Using Docker Compose
|
### 1. Using Docker Compose
|
||||||
|
|
||||||
1. Clone the repository:
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.dayanhub.com/kfir/tiny-url-microservice.git
|
|
||||||
cd tiny-url-microservice
|
|
||||||
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.
|
Your Nest.js server should now be running on port as like the port from the .env file.
|
||||||
|
|
||||||
|
|
||||||
### Using .env File
|
### 2. Using Dev Environment
|
||||||
|
|
||||||
1. Create a `.env` file in the root directory of your project.
|
run `npm run start:dev` to start the server.
|
||||||
2. Add the necessary environment variables to the `.env` file as shown below.
|
|
||||||
3. run `npm run start:dev` to start the server.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue