@@ -47,68 +47,20 @@ The structure of the server is split into different directories:
4747
4848### Basic Dependencies
4949
50- - Install Python 3.6/pip
51- - (Recommended) Create a virtual environment. todo(kcolton): finish + Pipfile
5250- [ Docker Community Edition (Stable)] ( https://docs.docker.com/install/ )
5351
54- Docker will run Postgres and Redis inside linux based "Containers" on most platforms.
55- Download and install Docker for your platform:
52+ Docker will run Postgres, Redis, Flask, Celery, and Node inside linux based "Containers" on most platforms.
53+ Download and install Docker and Docker Compose for your platform:
5654 - [ Mac/Windows: Docker Desktop] ( https://www.docker.com/products/docker-desktop )
5755 - [ Ubuntu/Debian-ish: Docker CLI] ( https://docs.docker.com/install/linux/docker-ce/debian/#install-docker-ce )
58- - Start Postgres and Redis containers:
59-
60- ``` bash
61- # Start Postgres and Redis. Anytime ran will automatically download latest versions.
62- # Should be in project root directory (where docker-compose.yml is)
63- docker-compose up
64-
65- # See your containers running
66- docker ps
67- ```
68-
69- todo(kcolton): extended Docker docs
70- - Install [NodeJS](https://nodejs.org/en/) - 8 LTS Recommended (10 likely works as well).
71-
72-
73- # ## Python Requirements
74-
75- - (Recommended) Activate virtual environment. todo(kcolton): finish
76- - Install python requirements
77-
78- ` ` ` bash
79- pip3 install -r requirements.txt
80- ` ` `
81-
82- # ## React Webapp requirements via `npm` (Node Package Manager)
8356
57+ ### Run Everything
8458``` bash
85- cd webapp
86- # if not found, upgrade npm or use: npm install
87- npm ci
88- ` ` `
59+ # Start containers. Should be in project root directory (where docker-compose.yml is)
60+ docker-compose up
8961
90- # ## Start Application
91-
92- todo(kcolton): alternative start methods
93-
94- - Flask (Web framework for Backend API)
95-
96- ` ` ` bash
97- # inside activated virtual environment if cerated
98- python3 RLBotServer.py
99- ` ` `
100-
101- - Celery (Background workers required for parsing replays and other tasks)
102-
103- ` ` ` bash
104- # inside activated virtual environment if created
105- celery -A backend.tasks.celery_tasks.celery worker --loglevel=INFO
106- ` ` `
107-
108- - React Web Frontend (Run on separate port, make calls to Backend API for data)
109-
110- ` ` ` bash
111- cd webapp
112- npm run start
113- ` ` `
62+ # See your containers running
63+ docker ps
64+ ```
11465
66+ Now go to ` localhost:3000 ` and the site should be running.
0 commit comments