Skip to content

Commit

Permalink
doc: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
arodindev committed Aug 4, 2024
1 parent 9ff9e3a commit c7f07e1
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,26 @@

## Getting started

Rename the `.env.sample` file to `.env` within the project folder or export the `MONGODB_URI` environment variable manually with `$ export MONGODB_URI=<YOUR_URI>`. The simplest way to start the production-ready application is via docker-compose.
TODO

## Development

TODO: Tilt + Docker compose

Rename the `.env.sample` file to `.env` within the project folder or export the `MONGODB_URI` environment variable manually with `$ export MONGODB_URI=<YOUR_URI>`. The application can be started in development mode via Poetry.

```bash
docker-compose up
docker-compose down
poetry run start
```

The application can be started in development mode via Poetry.
Pull MongoDB and run it:

```bash
poetry run start
docker pull mongo
docker run -p 27017:27017 mongo
```

## Running tests locally using Tox
#### Running tests locally using Tox

If you want to run tests and checks locally in an isolated environment. Useful if you want to make sure that all tests pass before passing new code to a CI/CD pipeline.

Expand Down

0 comments on commit c7f07e1

Please sign in to comment.