Application Description:
The Latino Medical Student Association strives to unite and empower pre-medical students through service, mentorship, and education to advocate for the health of the Latino community. Their vision is to unify pre-medical students to promote Latino health. This web application serves as tool for the organziation to streamine their points tracking system so both their members and officers can interact better.
- Daniel Ortiz-Chaves : Scrum-master
- Nikita Udodenko : Product Owner
- Alec Hubacher
- Matthew Mueller
- Zeling Li
Jira: https://lmsaplustracker.atlassian.net/jira/software/projects/G53/boards/4/backlog
This code has been run and tested on:
- Ruby - 3.0.2p107
- Rails - 6.1.4.1
- Ruby Gems - Listed in
Gemfile - PostgreSQL - 13.3
- Nodejs - v16.9.1
- Yarn - 1.22.11
- Docker - Download latest version at https://www.docker.com/products/docker-desktop
- Heroku CLI - Download latest version at https://devcenter.heroku.com/articles/heroku-cli
- Git - Downloat latest version at https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
Download this code repository by using git:
git clone https://github.com/EndlessDebugger/LMSA_Beyond.git
An RSpec test suite is available and can be ran using:
rspec spec .
Run the following code in Powershell if using windows or the terminal using Linux/Mac
cd lmsa_beyond
docker run --rm -it --volume "$(pwd):/rails_app" -e DATABASE_USER=test_app -e DATABASE_PASSWORD=test_password -p 3000:3000 dmartinez05/ruby_rails_postgresql:latest
cd rails_app
Install the app
bundle install && rails webpacker:install && rails db:create && db:migrate
Run the app
rails server --binding:0.0.0.0
The application can be seen using a browser and navigating to http://localhost:3000/
There are currently four envrionment variables that need to be configured. They can be set manually in the config/environments/development.rb for local development, but for other environments, one should configure these variables in Heroku deployment config variables
GOOGLE_OAUTH_CLIENT_ID
GOOGLE_OAUTH_CLIENT_SECRET
A more in depth guide for user authentication can be found in this Medium article for setting the Google authentication.
A Heroku pipeline is currently connected to this Github repository and configured such that updates are continually deployed when changes are detected. The procfile gives instructions to Heroku on how to configure the deployment such as creating, migrating, and seeding the database. Additionally, all envrionmental variables listed in the previous section must be added manually to the Heroku app in Settings>Config Vars.
Below are more detailed instructions for how to set this up:
Follow these instructions to create a Heroku account: https://signup.heroku.com/
From the heroku dashboard select New -> Create New Pipline
Name the pipeline, and link the respective git repo to the pipline
Our application does not need any extra options, so select Enable Review Apps right away
Click New app under review apps, and link your test branch from your repo
Under staging app, select Create new app and link your main branch from your repo
To add enviornment variables to enable google oauth2 functionality, head over to the settings tab on the pipeline dashboard
Scroll down until Reveal config vars
Add both your Google client id and your secret id, with fields GOOGLE_OAUTH_CLIENT_ID and GOOGLE_OAUTH_CLIENT_SECRET respectively
Now once your pipeline has built the apps, select Open app to open the app
With the staging app, if you would like to move the app to production, click the two up and down arrows and select Move to production
And now your application is setup and in production mode!
For continuous development, we set up Heroku to automatically deploy our apps when their respective github branches are updated. Currently there are three live deployments of this web app:
For continuous integration, we set up a Github action to run our specs, security checks, linter, etc. after every push or pull-request. This allows us to automatically ensure that our code is working as intended. The following are ran on every deployment, push, and PR:
Rspec tests
executes all unit and integration tests located in ./spec
Brakeman
security testing tool
Rubocop
code linter that can be configured in ./rubocop.yml
Officers and members looking for support should first look at the application help page. Members looking for further help should seek out assistance from the TAMU LMSA Plus officers.