Skip to content

Developer Resources

Jump to bottom
Tianye Meng edited this page Apr 23, 2025 · 17 revisions

Standing Up the Application

This guide walks you through setting up the Flextensions app on your local machine or on your Heroku server and preparing it for development and deployment.

Set Up in Your Local Environment

Clone the Repository

git clone git@github.com:cs169/flextensions.git
cd flextensions

Set Up Ruby Environment

Make sure you are using Ruby 3.3.0:

rvm use 3.3.0

If the above command errors because rvm 3.3.0 is not installed, then install it instead:

rvm install 3.3.0

Then install dependencies:

bundle install --without production

Environment Variables

  • Create a new file named .env under the root directory of Flextensions app.

  • Setup the following ENV variables in your .env file:

DB_PORT (default: 5432)
DB_USER (default: postgres)
DB_PASSWORD (default: password)
DB_NAME (default: postgres)
CANVAS_URL (No default, but if you are using instructure sandbox then it should be set as "https://www.instructure.com/canvas?domain=canvas")
RAILS_MASTER_KEY (Elaborated more in later sections)
CANVAS_CLIENT_ID (Ask the instructor for this. Used for authentication token request)
APP_KEY (Ask the instructor for this. Used for authentication token request)
CANVAS_REDIRECT_URI (URL to the app itself. If you are standing up the app locally then it should be "http://localhost:3000")
  • If you plan to run authentication Cucumber tests, add:
CANVAS_TEST_USERNAME="your bcourses sandbox username"
CANVAS_TEST_PASSWORD="your bcourses sandbox password"
CANVAS_TEST_NAME="your beautiful name"

Install PostgreSQL

On macOS:

brew install postgresql
brew services start postgresql@14
/opt/homebrew/opt/postgresql@14/bin/postgres -D /opt/homebrew/var/postgresql@14

Create PostgreSQL User

psql postgres

# In the PostgreSQL CLI:
CREATE USER flextensions WITH PASSWORD 'C5627872cd1e8e99312ecb9ec35C8538';
ALTER USER flextensions WITH SUPERUSER;
\q  # To exit

Standing Up the Application

  1. Setup the following ENV variables in heroku
APP_KEY
REDIRECT URI
CANVAS_CLIENT_ID
CANVAS_URL

RAILS_MASTER_KEY

Redirect uri should have domain-name/auth/callback

  1. Pushing branch Iter4 to flextensions heroku
heroku login

git remote add golden https://git.heroku.com/flextensions.git

git push golden main
  1. https://sp25-02-flextensions-4f5b4fbccd7f.herokuapp.com

Testing

Test Commands

Test Type Command
RSpec Tests (no a11y) bundle exec rspec --tag '~a11y'
Cucumber Tests (no a11y) bundle exec cucumber --tags 'not @a11y and not @skip'
All Regular Tests bundle exec rspec --tag '~a11y' && bundle exec cucumber --tags 'not @a11y and not @skip'
Accessibility Tests (RSpec) bundle exec rspec --tag a11y
Accessibility Tests (Cucumber) bundle exec cucumber --tags @a11y
All Tests (including a11y) bundle exec rspec && bundle exec cucumber --tags 'not @skip'
Lint Code (RuboCop) bundle exec rubocop
Auto-fix Lint Issues bundle exec rubocop -A
Validate Swagger API npx @redocly/cli lint app/assets/swagger/swagger.json --extends=minimal

Test Tags

Tag Description
@javascript Tests requiring JS execution in browser (uses Selenium/headless browser), without the tag, it will run in rack, which is exponentially faster to test
@a11y Accessibility tests using axe-core to verify WCAG compliance
@skip Temporarily skipped tests (known failures)
@wip Work In Progress tests still under development

Tips

  • Use ~ (RSpec) or not (Cucumber) to exclude tags
  • Combine tags in Cucumber with and/or: --tags '@javascript and not @skip'
  • Run accessibility tests separately (slower)

Conventions

  1. Testing convention css selector - <a class="nav-link testid-username" href="#"> Tashrique </a>

Notice the testid-usernameWe will be using this style in class to grab elements from DOM to test.

Please don't remove any class that starts with testid-

Clone this wiki locally