hpi-swa-lab / BP2021RH1

Crowd-Sourced Picture Archive for Bad Harzburg / BP2021RH1
https://bilder.bad-harzburg-stiftung.de/
MIT License
4 stars 0 forks source link

Crowd-Sourced Picture Archive for Bad Harzburg / BP2021RH1

For our web application we use React as a UI-framework and Strapi as a CMS. For the client-server communication we use GraphQL.

As an entry point we recommend reading our bachelor theses, especially chapter 4-6 as they focus on the implementation.

To understand our code it is important to know the fundamentals of TypeScript (if you haven’t worked with TypeScript/JavaScript before), React and GraphQL (also interesting: Strapi GraphQL API).

There are two main projects: bp-gallery and bp-strapi. The bp-gallery project includes the frontend code (React), bp-strapi the backend code (Strapi).

To start local development you first have to install node (≥14, recommended: 16) and yarn. After that you have to execute yarn install in the bp-gallery directory to install the dependencies.

By using the command yarn start in the bp-gallery directory you now can start a local instance of the React application. By default, this instance communicates with our production backend. How to set up a local backend instance and use it gets described here.

The whole Documentation can be found here.