Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jkulton/topical
A (very) minimalist message board written in Go
https://github.com/jkulton/topical
go golang heroku-ready message-board postgresql
Last synced: 7 days ago
JSON representation
A (very) minimalist message board written in Go
- Host: GitHub
- URL: https://github.com/jkulton/topical
- Owner: jkulton
- License: mit
- Created: 2021-03-11T03:28:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T02:21:56.000Z (8 months ago)
- Last Synced: 2024-06-19T05:58:08.852Z (5 months ago)
- Topics: go, golang, heroku-ready, message-board, postgresql
- Language: Go
- Homepage:
- Size: 168 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Topical
[](https://goreportcard.com/report/github.com/jkulton/topical)
Topical is a (very) minimalist message board built with Golang.
Users can create topics and reply with mesages. Users need only to pick an avatar color and two initials to get a signature and start posting.
Topical even supports **dark mode**. The preferred color scheme from your OS settings is used to decide which theme to display (update your OS setting to see!).
## Running Topical
The simplest way to run Topical is using Docker. Please ensure you have both Docker and Docker Compose installed, then do the following:
1. Clone this repo
2. Navigate into the repo
3. Run `docker-compose up`
4. Navigate to `localhost:8000` in your browser. Done!
---
## Development
Please ensure you have both Docker and Docker Compose installed, then do the following:
1. Clone this repo
2. Navigate into the repo
3. Run `docker-compose up db`
4. In another terminal window, in the repo directory also run:
```
go run ./cmd/topical \
-db-connection-uri='postgresql://topical:topical@localhost?sslmode=disable' \
-session-key=somethingSecret
```
5. Navigate to `localhost:8000` in your browser. Done!
You can change Topical's code locally and re-run the `go run` command to restart the server.
### Running Tests
- Run tests by executing `go test ./internal/...`.
- You can also get coverage information with the `-cover` flag (`go test ./... -cover`)
- **Note:** Integration-style tests may take longer to execute than unit tests as they involve setup and teardown phases.
### Options/Flags
Topical supports passing options via flag at start up or through an accompanying environment variable. Flags will take precedence over environment variables, if provided.
| Flag | ENV var | Default Fallback | Description |
|------|---------|---------|-------------|
| `p` | `PORT` | `8000` | Port for Topical to bind to |
| `database-url` | `DATABASE_URL` | `'not-set'` | URI-formatted Postgres connection information (e.g. `postgresql://localhost:5433...`) |
| `session-key` | `SESSION_KEY` | `'not-set'` | Session key for cookie store |
### Database Management
A few DB management scripts have been provided and will accomplish the following tasks:
| Script | Use |
|--------|-----|
| `db_init` | Creates the intial tables in the DB as specified in `./schema.sql` |
| `db_seed` | Seeds an existing database with data from `./seeds.sql` |
| `db_drop` | Drops tables from a Topical database |
| `db_reset` | Drops tables, creates tables, reseeds database |
Scripts can be run directly with `go run` but require passing a `-database-url` (if the environment variable is not set):
```sh
go run ./scripts/db_init \
-database-url='postgresql://topical:topical@localhost?sslmode=disable'
```