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

https://github.com/nouveau-printemps/webring


https://github.com/nouveau-printemps/webring

bun go minimalist scss simple toml webring website

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# Webring

Create a webring easily!

## Usage

To create your own webring, you have to install the application by building it by yourself or via Docker.

Then, you can start your server with the flag `-config path/to/config.toml`.
It will create a default config located at the given path.

### HTML files
You must create two HTML files for the pages join and legal information.
Their path is set in the config file.

You can use all common tags (like `p`, `a`, `h1`, `img`...).
The CSS class `text` is used when you want to display text.
The class `list` is used when you want to display a list into columns (like in the home).

### Public files
All static files are located inside the `public` directory.
These are available under the URI `/static/path_in_public`.

You can modify the favicon by putting an image called `logo.png` in your public directory.
You can change this name in the config.

## Technologies

It is an SSR compiled webserver.

- Go
- `go-chi/chi` router
- `BurntSushi/toml`
- SCSS