diff --git a/README.md b/README.md index fee1584..8108cca 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ [Django](https://www.djangoproject.com/) backend containing multiple small applications and api for Next.js frontend. -* **Web app:** Backend for the main website. -* **Member register:** Data table app for viewing and modifying the member register, member applications and membership payments. -* **Kaehmy:** Form for creating and listing kaehmys -* **Ohlhafv:** Form for creating and listing ohlhafv challenges. -* **Infoscreen:** Angular-based slideshow app for the guild room's screens. +* **Web app:** Backend for the main website. +* **Member register:** Data table app for viewing and modifying the member register, member applications and membership payments. +* **Kaehmy:** Form for creating and listing kaehmys +* **Ohlhafv:** Form for creating and listing ohlhafv challenges. +* **Infoscreen:** Angular-based slideshow app for the guild room's screens. + ## Installation Set up your SSH key authentication in GitLab Profile Settings. Then clone the repository and checkout the development branch: @@ -18,9 +19,10 @@ git checkout develop ``` Copy env file for local use: + ```bash cp .env.dev .env -``` +``` ### Poetry @@ -42,7 +44,7 @@ python3 -m poetry config virtualenvs.in-project true We use Node.js for few development tasks, like linting. Easiest way to install Node is [nvm](https://github.com/nvm-sh/nvm). After installing install dependencies: -``` +```bash npm install ``` @@ -53,6 +55,7 @@ TODO: List scripts To run a local development database **[docker](https://docs.docker.com/engine/install/)** is recommended. If you want to additianally use a db management tool **[pgAdmin](https://www.pgadmin.org/download/)** is nice. After installing docker use the following to create a database: + ```bash docker run --name sik.web.db -e POSTGRES_PASSWORD=postgres -p 5432:5432 -d postgres:12 ```