University of Windsor CSS Hub

http://css.uwindsor.ca

Overview

The University of Windsor Computer Science Society (CSS) website was built to provide students with the many resources that students and CSS has to offer. It provides a location for news, events, an open-source student guide, and even our exclusive authentication into our Discord server!

Contributing

Please feel free to contribute if you see an issue or think of a sweet feature! Simply fork this repo and make a pull request.

If this sounds like gibberish to you, you'll probably want to learn the basics of git. Afterwards, you can follow this tutorial on contributing to open-source projects on GitHub.

Rails Setup

You can follow these instructions to install ruby and the rails framework.

After installing rails, you need to install the dependencies (gems). Navigate to the project directory and run:

$ bundle install

Bundler will install all of the project dependencies (located in Gemfile) of the project.

Next you'll need to create the local database using

$ rails db:setup

After that you're ready to launch the site using:

$ rails server

By default, rails will launch the server at http://localhost:3000.

Office365 OAuth Setup

This is not necessary, however to sign in to your UWindsor email on your local instance and use admin features you will need to set up Office365 OAuth.

Signing in will allow you to access admin features such as:

Create/modify events
Modify page content in-site

Note: UWindsor currently doesn't allow us to create an application with our school's Microsoft account. You'll have to create the application on a different account such as your personal one.

Follow these steps from Microsoft to create an application and obtain the client ID and secret: https://docs.microsoft.com/en-us/graph/auth-register-app-v2

Name: whatever you want
Supported account types: Accounts in any organizational directory (Any Azure AD directory - Multitenant)
Redirect URI: http://localhost:3000/auth/microsoft_graph/callback

Now that you have an Azure client ID and client secret, you need to add those to your environment file where the app reads the keys. You can see your client (application) ID in your project overview. You can create your client secret under Certificates & secrets -> New client secret.

In the rails project, copy the local_env.example.yml to a new file called local_env.yml. This will be your private file that contains your API credentials - git will ignore this file. Fill in the AZURE_CLIENT_ID and AZURE_CLIENT_SECRET fields in local_env.yml with your respective credentials.

After restarting the rails server, you should be able to sign in using UWindsor accounts. You can now add yourself as an admin through the rails console. After signing into the app at least once (so that your user record is created), run rails console or rails c to open the console, then change your role to admin using: User.find_by(email: "youruwindsoremail").update(role: "admin")

Discord OAuth Setup

Discord auth setup will add the Discord functionality to your application. This is very similar to how we set up Google OAuth. This application uses Discord to:

Allow users to sign in/be added to the CSS Discord Server
Post messages in the Discord server (e.g. new events)

Go to the Discord Developer Portal
Create a new application (name it whatever you want)
Under your new application -> OAuth2, add http://localhost:3000/auth/discord/callback to your list of redirects
Under "Bot", create a new bot (name it whatever you want)
Copy the bot's client secret to DISCORD_BOT_TOKEN in local_env.yml
Under "General information", copy the client ID and secret (different from bot secret) to your local_env.yml file's DISCORD_CLIENT_ID and DISCORD_CLIENT_SECRET respectively
Now we need to add the bot your Discord server. Under "OAuth2", navigate to scopes and ensure that bot is checked. Under "Bot permissions", check Administrator
Under scopes you should see a generated invitation URL based on the permissions/scopes you've selected. Paste that link into your browser and you'll be able to add the bot to whichever server you choose
Finally, the application needs to know which server and channel it's sending messages and adding users to. You'll need to find your server and channel IDs and fill in DISCORD_SERVER_ID and DISCORD_ANNOUNCEMENT_CHANNEL_ID.

Now you're all set!

Environment Variables

The application uses many environment variables to store client information for third-party apps (like Office authentication, Discord bots, etc.). These environmnent variables should be stored in config/local_env.yml and a template exists in config/local_env.example.yml.

Each of these variables serves its own purpose (some described above in other sections). You do not need any of these configured to get the website running but you need them for certain things.

ENV Variable Name	Description
DISCORD_BOT_TOKEN	Discord application's bot token
DISCORD_CLIENT_ID	Discord application's client ID
DISCORD_CLIENT_SECRET	Discord application's client secret
DISCORD_SERVER_ID	Guild (server) ID for the Discord server that the application is adding users to
DISCORD_ANNOUNCEMENT_CHANNEL_ID	Channel ID for the channel that the bot will send event announcements to
HOST	Website URL (https://localhost:3000 for local instances)
GMAIL_USERNAME	Email address that the website sends emails from
GMAIL_PASSWORD	Password to the email address
AZURE_CLIENT_ID	Azure project's client ID (for signing into UWindsor accounts)
AZURE_CLIENT_SECRET	Azure project's client secret

Common issues

A few people reported issues with a dependency, libv8. This can be fixed by installing the libv8-dev package using: sudo apt-get install libv8-dev or brew install libv8-dev.

uwindsorcss/hub