hackclub / hackathons-backend

Powering https://hackathons.hackclub.com
https://hackathons.hackclub.com
MIT License
22 stars 5 forks source link
hackathons rails

Hackathons Backend

The thing that powers hackathons.hackclub.com!

📝 Application Form 📬 Subscription Email
Screenshot of Hackathons application form Screenshot of Hackathons subscription email

Contributing

This app is built with 🛤️ Ruby on Rails (running on the edge) and uses 🥋 Sidekiq/Redis for running background jobs.

Getting Started

  1. Make sure you have Docker and Ruby 3.3.5 installed.

  2. Clone the repo

    git clone https://github.com/hackclub/hackathons-backend.git
    cd hackathons-backend
  3. Install dependencies

    bundle install
  4. Setup the database and run the server

    rails db:prepare
    rails server

The application will now be running at localhost:3000!

Additional Dependencies

Rails 7 (Active Storage) depends on vips to process images. You'll want this dependency installed on your machine. For macs, run:

brew install vips

Production Deployment

Vendors:

Kamal

All pushes to the main branch are automatically deployed by Kamal.

Production Rails Console

We audit the use of the production console with console1984 and audits1984.

To use the production console, you must first have SSH access to the Hetzner server(s). Please ask @garyhtou for access.

Then, run the following locally on your computer:

bin/console prod

Sidekiq

Sidekiq is used to process background jobs in production. In development, we use the good old default Active Job Async queue adapter.

To check up on Sidekiq, visit /admin/sidekiq on the production site. You must be logged in as an admin to access this page.


Application performance monitoring sponsored by AppSignal .