BasGit

GitHub like web app to manage various kinds of information. More specific information somewhat soon. Maybe. You can find a bit more information in the wiki.

Compiling and testing

Installing compiler and dependencies

First, you have to install rustup to manage your Rust compilers. After doing that and cloning this repository, change into the clone's folder and set the compiler version for this project.

$ rustup override set nightly

Additionally you have to install lessc, a LESS compiler. On Ubuntu, this can be done via:

$ sudo apt install npm     # in case you don't have npm already
$ npm install -g less

Finally, we need to setup the database. For that, you need to install a PostgreSQL server (sudo apt install postgresql on Ubuntu) and the Diesel CLI tools (cargo install diesel_cli). Once these are installed, you have to execute diesel setup in this project's directory.

Compile and run the program

Now, you can simply run the application with:

$ cargo run

If compiling fails, you probably need to update your compiler version with rustup update nightly.

For any kind of production use, you should compile the application with cargo run --release and read the Rocket guide on this topic. For development, there is a helpful script util/watch.sh which automatically recompiles everything and restarts the server whenever files were changed. In order to use that script, you need to install watchexec: cargo install watchexec.

Contributing

Right now, this project is developed by me as part of a course at my university. As such, I'm not allowed to merge other people's code (yet). This limitation is lifted sometime in July this year. If you are interested in this project, please wait until then before working on the code.

---

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.