BoardHub is an interactive platform that allows users to create and manage bulletin board posts. The platform offers an organized space for people to share news, ideas, or requests. Simple and easy to use, users can create bulletin board posts and comment on other posts. It features a user-friendly interface and different types of feeds to view posts. Whether it's for a business, a community, a club, a school, personal use or more, BoardHub provides a convenient way to communicate and connect.
BoardHub may be used to create a bulletin board for a university. Students can post about events, clubs, or other topics. The university can also post about important news, announcements or job opportunities and internships. Students can search for project partners or find supervisors for their thesis.
BoardHub can provide an ideal platform for businesses. Whether it's posting important updates, celebrating employee achievements or sharing project opportunities, BoardHub provides a space for company-wide communication.
For private communities like neighborhood associations or clubs, BoardHub serves as a common space to share updates, arrange events or discuss community concerns. Residents can post about local issues, lost or found items, neighborhood recommendations or any general inquiries.
Docker and Docker Compose must be installed on your machine.
A ECDSA private key is required to sign JWTs. The key can be generated using the following command:
ssh-keygen -t ecdsa -f ./src/auth-service/key -m pemWhen using the provided compose.yaml file, the key must be placed in the auth-service directory and named key.
You may configure the path to the key and the name using the JWT_PRIVATE_KEY environment variable (see compose.yml).
Build the frontend using the following commands in the frontend directory:
npm install
npm run buildWe provide a compose.yaml file to run the application. To start the application, run the following command in the root directory of the project:
docker compose upThe frontend is accessible at http://localhost:3000.
The default api gateway config uses the following paths to route requests to the corresponding services:
| Path | Service |
|---|---|
/ |
frontend |
/auth |
auth-service |
/bulletin-board |
bulletin-feed |
/feed |
feed-service |
When started via docker-compose the database is automatically populated with example data when the application is started for the first time. We provide two sql files located in the scripts directory. The create.sql file creates the database and the tables. The insert.sql file inserts example data into the database.
An example user is created with the following credentials:
| Username | Password |
|---|---|
test |
test |
Along with some example posts.
See Kubernetes Setup for instructions on how to deploy the application to a Kubernetes cluster and how to import example data.
Florian Arens
florian.arens@stud.hs-flensburg.de
Hochschule Flensburg
Tiark Millat
tiark.millat@stud.hs-flensburg.de
Hochschule Flensburg
Finn Wessel
finn.wessel@stud.hs-flensburg.de
Hochschule Flensburg