Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
app
 
 
bin
 
 
 
 
db
 
 
lib
 
 
log
 
 
 
 
 
 
 
 
tmp
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

CardSwipr

Features

Event Attendance

CardSwipr helps event organizers take attendance at meetings and events. Users log in via CAS and create and manage events. The day of an event, Attendees can swipe in via an easy interface using their Yale ID. The application looks up attendees and collects their information in a list. When the event ends, organizers can download a spreadsheet (.csv) of the attendees' information.

Architecture

CardSwipr is meant to be deployed to a server in a Docker container with a PostgreSQL backend.

Data Architecture Model

Contributing

Getting Started

Using Docker:

This method requires Docker-Compose to be installed on your system. You can find information on that here: Docker-Compose

# Clone the repo
git clone https://gitlab.com/yale-sdmp/cardswipr.git
cd cardswipr

# Set up .env file
cp .env.example .env
# Uncomment the commented out section for docker and fill in required environment variables
# Note: leave any unneeded variables blank after the equals sign

#  Create the containers
docker-compose build
docker-compose up -d

# Set up rails
docker-compose exec web ./bin/setup

Local installation:

Make sure to have the specified Ruby version installed on your machine. We suggest using either rbenv or asdf if you need multiple concurrent versions of Ruby installed.

You will also need PostgreSQL installed on your machine.

# Clone the repo
git clone https://gitlab.com/yale-sdmp/cardswipr.git
cd cardswipr

# Set up environment variables
cp .env.example .env
# Fill out required environment variables, leaving any unneeded variables as blank after the equals sign

# Set up rails
./bin/setup

Running the test suite

After setting up the development environment you will be able to run our test suite.

Local Development

bin/rake

Docker Development

docker-compose run web bin/rake

About

Support or Contact

If you have trouble or questions about this application, email the managers of the Student Developer & Mentorship Program at dev-mgt@yale.edu.