Good Idea is a slightly fancier TODO app where anonymous users may submit requests and vote on their importance. Users do not need to login or create an account to make a request or cast votes.
- Postgresql Database
- environment variable
DATABASE_URLto point the server at the database
- go 1.21+
- node.js 18+
- Build and minify CSS and JS with:
npm install && npm run build - Build the server binary with
go build ./app/main.go
To make it easy, use make to build
make buildwhich will populate the static directory and build a binary called server
By default, the server will attempt to user local storage for images under static/img.
This can be changed by setting LOCAL_DIR within the environment.
If you prefer to use object storage instead, you can set the environment variables to provided the credentials needed to authenticate:
| variable | description |
|---|---|
| AWS_ACCESS_KEY_ID | The access key provided by your object storage provider for the S3 compatible sdk |
| AWS_SECRET_ACCESS_KEY | The secret key for authenticating to object storage |
| AWS_SESSION_TOKEN | The token for the current session which can be used |
| AWS_DEFAULT_REGION | The region the bucket is in |
In addition, the following variables may be used as well.
| variable | description |
|---|---|
| AWS_BUCKET | The name of the bucket to use within the object store |
| AWS_IMAGE_CDN | The URL (including the protocol, e.g. https) of the CDN which serves the images out of the bucket |
| AWS_ENDPOINT | The URI for the object storage to try and connect to if not AWS S3 |
The system checks for the environment variables AWS_BUCKET to decide if it should be using object storage or not
and thus, the rest are optional.
warning This project is in beta
For deployment information, please see the project wiki