https://github.com/subshell/group-challenge
upload and rate photos together 📸
https://github.com/subshell/group-challenge
party
Last synced: 5 months ago
JSON representation
upload and rate photos together 📸
- Host: GitHub
- URL: https://github.com/subshell/group-challenge
- Owner: subshell
- License: mit
- Created: 2021-02-23T07:42:10.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T13:00:09.000Z (over 1 year ago)
- Last Synced: 2025-12-28T18:47:55.461Z (6 months ago)
- Topics: party
- Language: TypeScript
- Homepage:
- Size: 2.31 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Group Challenge
[](https://github.com/subshell/group-challenge/actions/workflows/docker-publish.yml)
An easy-to-use website to create submission-based challenges that will be evaluated together in real-time.
Any user is allowed to create challenges with a fixed start and end date while others join and contribute.
Currently supported challenges are:
- 📸 **Photo Challenge**
## Configuration
The configuration is usally located under `/app/config.yaml`.
We also support configuration via environment variabels with a `GC_` prefix:
- `GC_SERVER_PORT`
- `GC_DB_USER`
- `GC_DB_PASSWORD`
**All available configuration options:**
```yaml
server:
port: 8080
staticFilesDir: "./static"
db:
user: postgres
password: postgres # prefered method: use env variable GC_DB_PASSWORD
database: group_challenge
host: "localhost:5432"
poolSize: 50
logQueries: false
challenges:
liveParty:
defaultTimePerSubmissionSeconds: 45
imgProxy:
enabled: true
url: "http://localhost:8081"
localFilePath: "/tmp/group-challenge-cache"
thumbnailQuality: 90
maxThumbnailWidth: 420
maxThumbnailHeight: 420
fullSizeQuality: 75
maxFullWidth: 1280
maxFullHeight: 1280
```
## Local development
This project includes pre-configured configuration files to launch the api, frontend, and postgres in VS Code.
Alternatively you can start all services with the following commands:
1. **Postgres:** start a postgres db at port `5432`.
```sh
mkdir /tmp/group-challenge-cache
docker compose up
```
2. **API:** start the go api server at port `8080`.
```sh
cd api && go mod tidy && go run main.go
```
3. **Frontend:** start the frontend at port `3000`.
```sh
cd frontend && npm i && npm run dev
```
## Container
For official container images visit https://github.com/subshell/group-challenge/pkgs/container/group-challenge
### Building the container
The container contains the frontend as well as the backend.
```sh
docker build . --tag group-challenge
```
### Running the container
Before you can run the `group-challenge` container, make sure that postgresql and optionally imgProxy is running.
You can start both applications with `mkdir /tmp/group-challenge-cache && docker-compose up`.
By default you can open your browser at http://localhost:8080/ to see the running group-challenge app.
#### Your localy created container
```sh
docker run --network=host group-challenge
```
#### Official container
```sh
docker run --network=host ghcr.io/subshell/group-challenge:latest
```
## Kubernetes support
The helm chart is available under https://subshell.github.io/helm-charts-lab/
```sh
helm repo add subshell-public https://subshell.github.io/helm-charts-lab
helm install -f gc-values.yaml group-challenge subshell-public/group-challenge
```
This chart uses the [Bitnami Postgres Helm Chart](https://github.com/bitnami/charts/tree/master/bitnami/postgresql) as a dependency. Configure it with `postgresql` in your `values.yaml` file.
You definitely want to change the password using `global.postgresql.postgresqlPassword` or a secret. You have to install the `pgcrypto` extension manually.
2. Open the browser at `http://localhost:8080`.
## Image processing
To reduce the size of all uploaded images, we support [imgProxy](https://docs.imgproxy.net). See `imgProxy` for its configuration.
---
Take a look at this project from the [subshell](https://subshell.com) team. We make [Sophora](https://subshell.com/sophora/): a content management software for content creation, curation, and distribution. [Join our team!](https://subshell.com/jobs/) | [Imprint](https://subshell.com/about/imprint/)