adamatti / rust-wiki

a wiki implementation using rust

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Same old wiki, but using rust lang.

This is my first project using rust, so it probably doesn’t follow the best practices. Be aware of it 😊

Features

  • Add/update/remove items with markdown, persisted on mongo

  • Security - single user, need to provider user/pass as env vars

  • Functional tests - mongo needs to be running, docker-compose provided

  • Ready to deploy to heroku - need to provide env vars:

    • APP_PASS

    • APP_USER

    • MONGODB_DATABASE

    • MONGODB_PASS

    • MONGODB_URI

    • MONGODB_USER

    • RUST_BACKTRACE = full (optional)

    • RUSTUP_TOOLCHAIN = nightly

Missing items

  • feature: tags

  • feature: search

  • asciidoc - there is no cargo implementation today

  • redis - parse is not slow as java to use cache, but I would like to play with it.

  • test coverage report

  • Dockerfile - why? to deploy to kubernetes

Stack / references

Questions / comments?

Feel free to contact me.

About

a wiki implementation using rust


Languages

Language:Rust 87.8%Language:Makefile 7.3%Language:Dockerfile 4.9%