An open API service indexing awesome lists of open source software.

https://github.com/willbicks/epigram

Epigram is a web-based quote wall for communities to record the enlightening, funny, or downright dumb things people say.
https://github.com/willbicks/epigram

go go-templates quotes web-application

Last synced: 4 months ago
JSON representation

Epigram is a web-based quote wall for communities to record the enlightening, funny, or downright dumb things people say.

Awesome Lists containing this project

README

          

# 💬 Epigram

> **[ep·i·gram][wikipedia]** _noun_
> : a pithy saying or remark expressing an idea in a clever and amusing way.

Epigram is a simple web service for communities to immortalize the enlightening, funny, or downright dumb quotes that they hear.

[wikipedia]: https://en.wikipedia.org/wiki/Epigram

## Features

- [x] Users can submit and view quotes.
- [x] Quotes are organized in chronological order, and in sections by year.
- [x] Authorization is delegated to a configurable OpenID Connect provider.
- [x] Access restricted to only those who correctly answer a few questions.
- [x] Dark mode support.
- [ ] Expanded admin control functions.

## Project Status

Epigram still under development, and should be considered a work in progress.

## Usage

### Installation

Epigram can be compiled and installed directly from source as follows:

```bash
go install github.com/willbicks/epigram@latest
```

Alternatively, Docker container images are available at [ghcr.io/willbicks/epigram](https://ghcr.io/willbicks/epigram).

## Documentation

- [Configuration](docs/config.md)
- [Project Structure / Architecture](docs/structure.md)

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss your proposed change.

Please make sure to update tests as appropriate.

## Copyright and License

Copyright (c) 2022 [Will Bicks](https://www.willbicks.com)

Distributed under the BSD 3-Clause License. For more details, see [LICENSE](LICENSE).