diff options
| -rw-r--r-- | README.md | 26 |
1 files changed, 14 insertions, 12 deletions
@@ -1,33 +1,35 @@ -# Python Discord Forms (Backend) -API for Python Discord forms (https://forms.pythondiscord.com) that handles Discord login and forms, submissions. +# Python Discord Forms API +API for [Python Discord Forms](https://forms.pythondiscord.com) that handles Discord OAuth2 integration and form submission. ## Setup ### Prerequisites -To start working on forms-backend, you need few things: -1. Discord Application (in [Developers Portal](https://discord.com/developers/applications)) +To start working on forms-backend, you'll need few things: +1. Discord OAuth2 Application (from the [Discord Developers Portal](https://discord.com/developers/applications)) 2. Poetry 3. Docker and docker-compose (optional) 4. Running MongoDB instance (when not using Docker) ### Running with Docker -Easiest way to run this is using Docker (and docker-compose). +The easiest way to run forms-backend is using Docker (and docker-compose). #### Environment variables -Set following environment variables to `.env` file: -- `OAUTH2_CLIENT_ID`: Client ID of Discord Application (prerequisites point 1). -- `OAUTH2_CLIENT_SECRET`: Client Secret of Discord Application (prerequisites point 1). +Create a `.env` file in the root with the following values inside it: +- `OAUTH2_CLIENT_ID`: Client ID of Discord OAuth2 Application (see prerequisites). +- `OAUTH2_CLIENT_SECRET`: Client Secret of Discord OAuth2 Application (see prerequisites). - `ALLOWED_URL`: Allowed origin for CORS middleware. #### Running -Running is really for this way: `docker-compose up`! And this is all: You can access now API from `http://localhost:8000`. +To start using the application, simply run `docker-compose up` in the repository root. You'll be able to access the application by visiting http://localhost:8000/ ### Running on host -Another way to run forms-backend is manually in host. +You can also run forms-backend manually on the host. #### Environment variables -First all same than in Docker environment variables section, with following additions: +Create a `.env` file with the same contents as the Docker section above and the following new variables: - `DATABASE_URL`: MongoDB instance URI, in format `mongodb://(username):(password)@(database IP or domain):(port)`. - `MONGO_DB`: MongoDB database name, defaults to `pydis_forms`. #### Running -Almost same easy than for Docker: `uvicorn --reload --host 0.0.0.0 --debug "backend:app`. +Simply run: `$ uvicorn --reload --host 0.0.0.0 --debug backend:app`. + +Once this is running the API will live-reload on any changes. |