Skip to content
This repository has been archived by the owner on Apr 23, 2021. It is now read-only.
/ observatory-new Public archive

The new (and improved) RCOS website

License

MIT, CC-BY-4.0 licenses found

Licenses found

MIT
LICENSE
CC-BY-4.0
COPYING
Notifications You must be signed in to change notification settings

rcos/observatory-new

Repository files navigation

Observatory-new

Build Status Badge

RCOS Observatory logo

Rewrite of the RCOS observatory in a way that hopefully makes a bit more sense. Since we have kinda lost track of what number we're on at this point I am codenaming this version Observatory-New (I think it's the 5th version though).

This implementation is intended to be simpler than previous incarnations in order to be easier to maintain in the long run.

It renders pages as plain HTML with minimal JavaScript and uses SQLite as the database backend.

If you would like to help out please read CONTRIBUTING.md.

Major Dependencies

Building

Before anything else make sure that you have the development tools for your system. On Ubuntu/Debian you can install these with:

$ sudo apt install build-essential pkg-config

Then you need to install the openssl development headers. How to do this varies by system but on Ubuntu the package is libssl-dev and should be similar on other distros.

Next install Rust with Rustup. Instructions are on the website linked and is fairly straightforward.

Rocket requires Rust Nightly (for now). This can be set for the Observatory-new repository folder specifically by running

rustup override set nightly

in cloned folder. As of Rustup 1.20.0 this will automatically install the additional tools and can be updated with rustup update.

After that it's as simple as

$ cargo build

And to run the project do

$ cargo run

then open your browser to http://localhost:8000

Documentation

Documentation for the project as a whole can be found within the docs folder and contains a variety of useful information.

The code is primarily documented using in-code doc comments. This can be viewed either by browsing the source or in a web browser with.

$ cargo doc --no-deps --document-private-items --all-features --open

Acknowledgements and License

A big shoutout to the RCOS community as well as the professors who guided us!

Source Code in this repository is subject to the terms of the MIT license provided in the LICENSE file unless otherwise specified.

Images and other artistic assets in this repository are under the terms of the CC-BY-4.0 license provided in the COPYING unless otherwise specified.