Scuffed Note

An Ali Express version of privnote

Goals

• Experiment with rocket
• Learn some rust
• Have some fun
• Create a simple web service that can:
  • create private notes with limited uses
  • fetch notes via url

Non Goals

• Deployment on actual prod environment

TODOS

• Encrypt notes on creation
• Password protect notes
• Add auto-expire to notes
• Add usage counter to notes
• Add unique urls to notes

How to run

1. Install rust. Easily done via rustup
2. Clone Project
3. cd scuffed-note && cargo run
4. 🚀 Rocket has launched from http://127.0.0.1:8000

To create notes, fire up a POST request to localhost:8000/notes with the following JSON body:

{
    "contents": "my super secret note",
    "uses": 1
}

Which will give you back a JSON response with the URL at which you can fetch it:

{
    "url": "http://localhost:8000/notes/uDxj46z2AhON9ev2"
}

Contributors

• Vasil Statev
• Michele Vigilante