Sprout is an application designed to connect people with charitable organizations. It aims to help potential donors find organizations that align with their values while providing these organizations with an accessible platform to showcase themselves.
The current state of main can be seen here.
A manual on how to deploy on your own can be found in build.
There are multiple steps required to start the application locally. The commands
assume you start every command from the root of this project (w.r.t. cd) and
are on a linux bash.
Please ensure you have docker and npm installed before you start.
cd auth/ && docker compose up -dSee auth/README for a more detailed description of Keycloak Docker container setup and tear down.
cd database/ && docker compose up -dSee database/README on how to start the development database using Docker.
cd frontend/ && npx auth secret && npm ci && npm run devnpx auth secret is only required once to create a secret key for the frontend.
Note: This cmd blocks the terminal. You will need a second one to start the backend.
See (frontend/README) for further informations.
If the backend server (in step 4) has issues starting, it might help to start with
npm run dev -- --hostinstead. After the backend has started, it should be possible to restart the frontend dev server, even while the backend is still running.
cd backend/ && ./gradlew bootRun --args="--appconfig.oauth2.users-issuer.issuer-uri=http://localhost:5173/authkc/realms/sprout-users --appconfig.oauth2.orgas-issuer.issuer-uri=http://localhost:5173/authkc/realms/sprout-orgs"See (backend/README) for further informations and trouble shooting.
The project was created as part of a university project for the graduate Software Engineering degree program at the University Augsburg, LMU, and TUM.
- Hannah Coenen
- Maximilian Mitterrutzner
- Fabian Nowak
- Nico Petzendorfer
- Robin Sögtrop