Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/fssay/secrets-cafe

Website for sharing stories anonymously
https://github.com/fssay/secrets-cafe

hyper-rs rust rust-lang surrealdb vanilla-js

Last synced: 3 months ago
JSON representation

Website for sharing stories anonymously

Awesome Lists containing this project

README 

        
# Secrets Cafe

Source of the web page [secrets.cafe](https://secrets.cafe/) which is a platform for people to share their stories anonymously.



Currently, this is not a finished product, it lacks many features and is filled with bugs. 

I am not a frontend developer, so the website lacks proper support for mobile devices and the JS scripts might have a lot of issues.

If you would like to help see [Contributions](#contributions) section.



### Usage

If you want to run **secrets.cafe** locally I would recommend building it in a release mode without any features. 


`cargo run --release`



Running in the debug mode might cause a crash when doing some database operations.

It can be fixed by increasing the stack size with tokio runtime builder, but I did not implement it yet.



### Features

- `tls` - This is an internal feature used as a "_dependency_" of other features for serving data over HTTPS.

- `cloudflare` - Implementation of the TLS to work with Cloudflare certificates.

- `rate-limits` - Enables rate limits on some API calls.



### ToDo

This is a list of things to do before 1.0 release

- [ ] Test HTML sanitizer.

- [ ] Improve security.

- [ ] Rework frontend.

- [ ] Rework resource loading. _(?)_

- [x] Add rate limits.

- [ ] Add proper API documentation.

- [ ] Add post page browser.



### Contributions

The backend works by serving static vanilla files. 

To comply with the backend it's important that your framework of choice allows to build the project into static vanilla files.



Please put the frontend source files into the [frontend-src](frontend-src) directory. 

It should also contain a brief tutorial on how to build the project. 

If that's possible it would be amazing if the build process could automatically update the [frontend](frontend) directory.



New static vanilla files should be placed into [frontend](frontend) directory.

If you want to add new files, or remove the existing ones please update the [resources](frontend/resources.json) file.




_(Files placed in the section `"other"` might not work correctly, if that happens please notify me)_



Any additional details like API endpoints and style guidelines can be found at [docs](docs) directory.

You don't have to follow the style guidelines.



For any questions please create an issue, or join [this](https://opensourceforce.net/discord) discord server and visit the [Secrets Cafe channel](https://canary.discord.com/channels/913584348937207839/1213547496375189534).



**These are the current reworks that are being worked on:**

- https://github.com/mk-nlp/secrets-cafe



### API

Check out the [API.md](docs/API.md) file for details.



### Console

The backend accepts input commands that can be executed at runtime:

- `debug` - Responds with Ok status

- `reload frontend` - Reloads all resources from "frontend" directory.

- `mod add   ` - Adds a new moderator account.

   ###### Example: `mod add User1 1234567 1`

- `mod authorise  ` - Changes mod's permissions tier.

   ###### Example: `mod authorise mod:62345321545 3`



Tier numbers can be found at `src/database/types/tier.rs`



---

[secrets.cafe](https://secrets.cafe) © 2024 by [FssAy](https://github.com/FssAy) is licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1)