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 dag geleden
.circleci changed circleci docker image 3 maanden geleden
.github Add pull request template 4 maanden geleden
migrations News annoucements 1 maand geleden
scripts A few fixes 3 maanden geleden
src small conditional change 2 weken geleden
static Workaround for #38 4 maanden geleden
templates News annoucements 1 maand geleden
.dockerignore Fix CircleCI again 3 maanden geleden
.gitignore Mentors can see meeting codes 4 maanden geleden
CONTRIBUTING.md Update some docs 4 maanden geleden
Cargo.toml Update rust-embed to 5.1.0 3 maanden geleden
DEPLOYING.md Update the README 4 maanden geleden
Dockerfile Fixed Dockerfile 3 maanden geleden
LICENSE Users lists 6 maanden geleden
README.md Update readme with Rustup update 1 dag geleden
Rocket.toml Fix some bugs 4 weken geleden
diesel.toml Diesel setup and basic schemas 6 maanden geleden
logo.svg optimized logo svg 2 maanden geleden

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