Lecture Hall is our custom workshop viewer available at https://workshops.hackclub.com. It takes the content from hackclub/hackclub and makes it beautiful and extra easy to access.
The project's goals are threefold:
- Improve accessibility of workshops (ex. have open all links in new tabs by default)
- Improve accessibility of our community (ex. through an embedded Slack client)
- Better track engagement of our users through integration with analytics tools
Lecture Hall is developed using Docker Compose. If you don't already have it installed, do that now.
Start by cloning the repository recursively so you get all submodules.
$ git clone --recursive git@github.com:hackclub/lecture-hall.git
Create a file called .env with the following contents. Replace text between < and > with actual info.
GITHUB_CLIENT_ID=<REPLACE>
GITHUB_CLIENT_SECRET=<REPLACE>
SEGMENT_WRITE_KEY=<REPLACE>
SENTRY_PRIVATE_DSN=<REPLACE>
SENTRY_PUBLIC_DSN=<REPLACE>
Finally, create the database and run migrations.
$ docker-compose run web rails db:create
$ docker-compose run web rails db:migrate
And then start the app! It's that easy.
$ docker-compose up
Lecture Hall is configured to store all installed gems in a separate volume called bundle. If you want to install a new gem, just add it to Gemfile and then run the following command to get it installed.
$ docker-compose run web bundle
See LICENSE.