aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorGravatar Hassan Abouelela <[email protected]>2021-02-28 14:41:47 +0300
committerGravatar GitHub <[email protected]>2021-02-28 14:41:47 +0300
commitf15dc347713147fe7d69ac1e866a178f63df3a07 (patch)
tree20fabe2c7f2d8e915211ef56b75bec78bc55d010 /README.md
parentBump uvicorn from 0.13.3 to 0.13.4 (diff)
parentMerge pull request #63 from python-discord/feat/9/unittest-validation (diff)
Merge branch 'main' into dependabot/pip/uvicorn-0.13.4
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3e38ef5..be0c8b9 100644
--- a/README.md
+++ b/README.md
@@ -8,6 +8,7 @@ To start working on forms-backend, you'll need few things:
2. Poetry
3. Docker and docker-compose (optional)
4. Running MongoDB instance (when not using Docker)
+5. Running [Snekbox](https://git.pydis.com/snekbox) instance (when not using Docker, optional)
### Running with Docker
The easiest way to run forms-backend is using Docker (and docker-compose).
@@ -29,6 +30,7 @@ Create a `.env` file with the same contents as the Docker section above and the
- `FRONTEND_URL`: Forms frontend URL.
- `DATABASE_URL`: MongoDB instance URI, in format `mongodb://(username):(password)@(database IP or domain):(port)`.
- `MONGO_DB`: MongoDB database name, defaults to `pydis_forms`.
+- `SNEKBOX_URL`: Snekbox evaluation endpoint.
#### Running
Simply run: `$ uvicorn --reload --host 0.0.0.0 --debug backend:app`.