nora
/
codepage
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Make README more friendly

This commit is contained in:
Leonora Tindall 2019-09-26 17:52:17 -05:00
parent b375760aab
commit 6d7fa271a0
Signed by: nora
GPG Key ID: 99041B68DBC02DAC
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,3 +1,16 @@
## Setup
# CodePage
CodePage is a code-sharing website curated by the community and built with open source
technologies.
## Architecture
CodePage is built with Flask and uses PostgreSQL as its database backend. In this repository,
there is a `docker-compose.yml` file specifying two containers, `database` and `webserver`.
If you want to install Postgres and Python on your local machine that is fine too. Just
change the relevant configuration in the `webserver` directory to point to your Postgres
instance and install the same packages that are installed by the `webserver` Dockerfile.
## Setup
Build the Docker containers with `docker-compose build`
Create the database schema `docker-compose exec webserver python src/makedb.py`