Kwasow / egg

The official website of the student conference organized by the gynecology student association

egg

The source code for the official website of the student conference organized by the gynecology student association at Warsaw Medical University.

Prerequisites

During development the app runs in a docker container alongside a postgres database using docker compose. You can find install instructions here:

• https://docs.docker.com/engine/install/
• https://docs.docker.com/compose/install/

Code style

If you're using vscode it is recommended to install the eslint plugin which will enforce the code style set in .eslintrc.json

Code style rules include:

• indent using spaces (2)
• use single quotes for strings
• never use semicolons

Running

To build all the necessary docker images run:

docker compose build

To run the project run:

docker compose up

Webpack should watch for files changes that you do on the host machine and automatically recompile the app. This feature has been tested on Linux.

Project architecture

// TODO

The servers backend is built in PHP.