paul
/
rocket-pinboard
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
A web application for handling notes that are accessible to everyone (like on a pinboard).
119 Commits 2 Branches 2 Tags 2.3 MiB
JavaScript 42.7%
CSS 29.3%
SCSS 25.9%
Rust 2.1%
Go to file
Paul van Tilburg d6dd43c7f2
Fix clippy issues; change imports 		2022-10-17 19:34:24 +02:00
src Fix clippy issues; change imports 2022-10-17 19:34:24 +02:00
static Rename list to note throughout the application 2018-01-26 21:18:04 +01:00
templates Rename the package (and application) to Rocket Pinboard 2018-03-09 22:37:47 +01:00
test/notes More renaming of list to note (in test, docs, etc.) 2018-03-09 22:23:27 +01:00
.gitignore Ignore GNOME Builder's build config 2018-12-18 15:50:47 +01:00
CHANGELOG.md More renaming of list to note (in test, docs, etc.) 2018-03-09 22:23:27 +01:00
Cargo.lock Port to Rocket 0.5.0-rc2 2022-10-17 19:18:35 +02:00
Cargo.toml Port to Rocket 0.5.0-rc2 2022-10-17 19:18:35 +02:00
LICENSE Add a REAMDE, LICENSE and (empty) CHANGELOG Markdown file 2018-01-02 13:18:58 +01:00
README.md Rename the package (and application) to Rocket Pinboard 2018-03-09 22:37:47 +01:00
Rocket.toml Port to Rocket 0.5.0-rc1 2021-06-13 21:59:44 +02:00
config.toml Read config from config.toml; add it to the state 2018-03-09 22:27:45 +01:00
deny.toml Update deny.toml 2020-11-24 15:41:51 +01:00

README.md

Rocket Pinboard

A Rocket based web application written in Rust for maintaining a pinboard of notes for a family or group of friends. Similarly to a Wiki, all notes can be edited by everyone, as a board with physical notes would also allow.

Building

Because Rocket still requires a nightly version of Rust, Rocket Pinboard also requires it. The application has been tested with nightly-2018-01-13.

Rocket Pinboard uses a customized Bootstrap-style, to compile this, use the Ruby implementation of Sass:

$ gem install sass
...
$ scss static/scss/pinboard.scss:static/csss/pinboard.css

Usage

The notes are stored as plain text files (in Markdown format) under the notes subdirectory. As an administrator of the application, you should touch a file with the extension .note in this subdirectory to create notes. The resulting note names are the title cased version of the snake cased filenames. For example to create a note for "John Doe":

$ touch notes/john_doe.note

After creating new notes, start (or restart) the application and then visit: http://localhost:8000/.

For setting up production or staging environments, see the Rocket documentation about configuring different environments.

To Do

There are still quite some things left to do. Here are some points of improvement for the future:

  • Use a Rust-implementation for Sass
  • Support different sets of notes (for different environments)
  • Get rid of hardcoded strings in the UI (for example the name of my family)
  • Add i18n to support several languages
  • Support locking a note while editing it in the client so other clients cannot edit it

License

Pinboard is licensed under the MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT).