From 6d7fa271a0ebdbd733a4f071b9c41cb452508aed Mon Sep 17 00:00:00 2001 From: Leonora Tindall Date: Thu, 26 Sep 2019 17:52:17 -0500 Subject: [PATCH] Make README more friendly --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d842378..44bb027 100644 --- a/README.md +++ b/README.md @@ -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` +