GovHack - Hackerspace
A system for competition participants, sponsors, and volunteers. For details on how to reset Hackerspace for the new year, scroll down.
Framework
Hackerspace 3 is a Ruby on Rails application
Current major version is 7
Check out the Rails Guides to get up and running.
There is also a Dockerfile with instructions on how to get up and running in our wiki.
Ruby version
Database initialization and creation
PostgreSQL is required.
$ rails db:setup
This will also load seed data, see db/seeds.rb for more options
Test Suite
Current coverage is unit tests for models, controllers, and service classes.
$ rails test
External Services
hackerspace3 makes use of AWS and Google services.
See the below Environment Variables section to enable specific services.
Specification Documents
All documents relating to specification can be found in the project
wiki.
Environment Variables
Environment variables only need to be set if external services (Google Maps, S3) need to be tested.
Set these in config/application.yml
using figaro
Seed File
Optional: Set if running in development and running the seed file.
- SEED_EMAIL (defaults to: admin@hackerspace.com)
- SEED_NAME (defaults to: Admin User)
Web Deployment
Set if running in staging or production environments.
Google Authentication
- GOOGLE_CLIENT_ID
- GOOGLE_CLIENT_SECRET
Slack Intergration
- SLACK_CLIENT_ID
- SLACK_CLIENT_SECRET
- SLACK_TEAM_ID
- SLACK_BOT_TOKEN
- note: requires
channels:manage
scope
AWS Simple Email Service
- AWS_SES_ID
- AWS_SES_KEY
- AWS_SES_SERVER
- DEFAULT_FROM_EMAIL
AWS S3
- AWS_ACCESS_ID
- AWS_ACCESS_KEY
- AWS_S3_REGION
- AWS_S3_BUCKET
Google Maps API
Mailchimp
- MAILCHIMP_API_KEY
- MAILCHIMP_LIST_ID
Restting Hackerspace for the new year
Knowledge/Exp required: AWS, SSH, Unix, Nginx, Postgres experience.
- Added new DNS entry for 2024 (AWS Console -> Route 53)
- Updated /etc/nginx/sites-enabled/hackerspace-production.conf server_name to include 2024
- Restarted nginx (needed to create my own sudo account with a password)
- Insert a new competition row into competitions table via postgres
- Insert an admin role for self and the new competition year via postgres
- In hackerspace switch over current year
- In hackerspace assign the competition management team
Contributing
Filter the issues section to "good first issue"