Build deploy documentation

Build and deploy documentation

How to build

⚠️ There is currently no common build system in place. Current development focuses on this issue, which is tracked by #37 and #60.

Prerequisites

1. Clone the repository via
   git clone https://github.com/amosproj/amos-ss2021-project2-context-map.git

2. Install node from https://nodejs.org/en/.
   It is required to install node with version 12.x or higher.

3. Install yarn by running
   npm i -g yarn

Run the project

⚠️ Scripts are currently only available for the windows platform or platforms that have powershell installed

To start the project, navigate to the /build directory within the repository clone and run each of the scripts in the following order within a separate shell instance.

1. start-database.ps1
2. start-backend-dbg.ps1 
3. start-frontend-dbg.ps1

How to deploy

⚠️ Deployment currently is only rudimentary. There is no automatic deployment. #151 tracks the deployability to docker containers for easy setup.

Frontend

1. Make sure to have all the prerequisites from above
2. Navigate to the /frontend in the project directory
3. Execute yarn install to install the dependencies
4. Execute yarn build to build the frontend project. The build output is located in the dist folder.
5. To configure the frontend, add a .env file to the build output. An example is included in the project sources.

Backend

1. Make sure to have all the prerequisites from above
2. Navigate to the /backend in the project directory
3. Execute yarn install to install the dependencies
4. Execute yarn build to build the frontend project. The build output is located in the dist folder.
5. To configure the frontend, add a .env file to the build output. An example is included in the project sources.