Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
echtejosh authored Dec 18, 2023
1 parent 1fce019 commit 717677c
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,17 +26,11 @@ Clone the repo on your system:

Then, navigate to the directory and install the NPM packages:

> **IMPORTANT**
Make sure you install [FFmpeg](https://ffmpeg.org/) on your system before continuing.
npm install


npm install

### Credentials

> **IMPORTANT**
Mongoose requires Atlas. See [here](https://www.mongodb.com/docs/manual/reference/connection-string/) for more information.

Navigate to `.env.example` and replace the placeholders, after that rename the file to `.env`.

### Usage
Expand All @@ -51,10 +45,6 @@ To start the project:
Navigate to `docker-compose.yml` and set variable values inside of environment.

### Usage

> **IMPORTANT**
For windows, make sure that you use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) when using `docker-compose build`.

Before you run, make sure you build the container first:

docker-compose build
Expand All @@ -64,3 +54,8 @@ To start the project:
docker-compose up


### Additional Notes

- For windows, make sure that you use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) when using `docker-compose build`.
- Make sure you install [FFmpeg](https://ffmpeg.org/) on your system before continuing.
- Mongoose requires Atlas. See [here](https://www.mongodb.com/docs/manual/reference/connection-string/) for more information.

0 comments on commit 717677c

Please sign in to comment.