Commit 666e68d2 authored by tsukumi's avatar tsukumi

Change: update README.md

parent d8465ed4
......@@ -9,6 +9,8 @@ Backend (this repository):
## Setup
Beforehand, Python 3.9 and MongoDB must be installed.
Run the following commands in order.
```bash
......@@ -21,6 +23,9 @@ $ pip install --no-cache-dir -r requirements.txt
$ cp .env.example .env
```
You need to modify `MONGO_DB`, `MONGO_USERNAME`, `MONGO_PASSWORD` in the .env file to suit your environment.
Please edit the .env file in an editor.
Run the api server with the following command.
By default, the API server is listening on port 9001.
......@@ -31,6 +36,8 @@ $ ./docker-entry.sh .env
## Setup with Docker
Beforehand, Docker and Docker-Compose must be installed.
Run the following commands in order.
```bash
......@@ -41,7 +48,7 @@ $ cd shadowban-eu-backend
$ cp .env.example .env
```
If you use Docker, you need to change `MONGO_HOST` in .env from `localhost` to `mongo` .
If you use Docker, you need to modify `MONGO_HOST` in the .env file from `localhost` to `mongo` .
Please edit the .env file in an editor.
Run the api server with the following command.
......@@ -51,3 +58,10 @@ By default, the API server is listening on port 9001.
# The first time you run it, the container will be created automatically
$ docker-compose up -d
```
## Note
The default is to test without login.
You can also test with login. Copy accounts.example.json to accounts.json and set the username (screen name) and password.
But, doesn't work at this time because the login API for the Twitter Web App has changed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment