Skip to content

rubynz/membership-register

Folders and files

NameName
Last commit message
Last commit date

Latest commit

2717d79 · Jul 3, 2024
Mar 21, 2023
Jun 30, 2024
Jul 3, 2024
Jun 30, 2024
Jan 16, 2022
Aug 16, 2016
Aug 15, 2016
Aug 15, 2016
Jun 30, 2024
Aug 15, 2016
Aug 15, 2016
Jul 15, 2021
Mar 21, 2023
Jul 19, 2021
Mar 21, 2023
Aug 12, 2021
Jul 1, 2024
Jul 3, 2024
Jun 30, 2024
Jul 1, 2024
Oct 21, 2022
Oct 28, 2022
Aug 15, 2016
Nov 22, 2021
Jul 15, 2021
Jul 15, 2021
Jun 30, 2024
Aug 3, 2023
Mar 15, 2023
Jul 15, 2021
Oct 21, 2022
Mar 15, 2023

Repository files navigation

Membership Register

Keeps track of membership to a society.

Getting started

Prerequisites

  • Ruby (See .ruby-version for the version you have to install)
  • Nodejs (for building assets, not required for production)
  • Postgres

Set-up

Clone this repository and run the following from the working directory:

bin/setup
yarn install

This will install dependencies, create a development and test database, and install nodejs dependencies.

Start

To start a local server, run:

bin/rails server

By default, this will start a local webserver on http://localhost:3000

And

yarn build --watch

Testing

This codebase started out without tests. Some are being introduced over time.

To run tests:

bundle exec rspec

Voting

Voting can be enabled by setting a VOTE_URL_TEMPLATE environment variable.

VOTE_URL_TEMPLATE=https://voting-site.com/token=%token%

When set, a message will appear on the home page, and members will be able to get a unique link emailed to them through a form, which substitutes %token% in the URL template with each member's unique voting_token.

Deployment

To deploy this app you need Nodejs to compile the assets, but only Ruby to run the production server.

Heroku should identify you need those two dependencies, if it does not, please refer to the Buildpacks documentation.