Skip to content

Developer Quick Start

Stephen Yeargin edited this page Jan 3, 2022 · 1 revision

Requirements

  • Ruby 2.7+
  • Bundler
  • Node
  • NPM
  • MySQL

Setup

This will get a working site going (without any Chapters)

  1. Clone the repository
  2. Copy .env to .env.local (or .env.<development|test|production> as needed)
  3. Update the file with the DATABASE_URL credentials
  4. bundle install
  5. npm install
  6. bin/rails db:setup
  7. bin/rails css:build
  8. bin/rails javascripts:build
  9. rails s

Create a User

$ rails c
>>> User.create(email: 'user@example.org', password: 'your_password_here')

Access the Site Admin

http://localhost:3000/admin

Upload a Chapter List

Use the CSV template below for the upload functionality.

name,institution_name,location,website,region,district

Fields:

  • name - Name of the chapter (e.g. Tennessee Kappa)
  • institution_name - Host college/university
  • location - <City>, <State> of chapter
  • website - Website URL, including https://
  • region - Larger grouping of chapters
  • district - Smaller grouping of chapters

You can optionally include:

  • slc - (1 or 0) Show SigEp Learning Community designation
  • latitude - Latitude for chapter office/house
  • longitude - Latitude for chapter office/house

Geocoding Chapters

The console includes a rudimentary script that will use the institution_name (falling back to the location) of a chapter to find it's latitude/longitude by querying Wikipedia. Not meant to be very precise.

$ bin/rails app:geocode_chapters
Clone this wiki locally