The new (and improved) RCOS website
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Steven vanZyl ffd6708291 Merge branch 'master' of github.com:rcos/observatory-new 1 giorno fa
.circleci changed circleci docker image 3 mesi fa
.github Add pull request template 4 mesi fa
migrations News annoucements 1 mese fa
scripts A few fixes 3 mesi fa
src small conditional change 2 settimane fa
static Workaround for #38 4 mesi fa
templates News annoucements 1 mese fa
.dockerignore Fix CircleCI again 3 mesi fa
.gitignore Mentors can see meeting codes 4 mesi fa
CONTRIBUTING.md Update some docs 4 mesi fa
Cargo.toml Update rust-embed to 5.1.0 3 mesi fa
DEPLOYING.md Update the README 4 mesi fa
Dockerfile Fixed Dockerfile 3 mesi fa
LICENSE Users lists 6 mesi fa
README.md Update readme with Rustup update 1 giorno fa
Rocket.toml Fix some bugs 4 settimane fa
diesel.toml Diesel setup and basic schemas 6 mesi fa
logo.svg optimized logo svg 2 mesi fa

README.md

Observatory-new

CircleCI

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 do

$ cargo run

Deploying

This is for deploying to a server, not a developer machine

Please read the Deploying instructions for information on how to setup and deploy observatory-new.

Documentation

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