README

Shows how to use turbo-frames using the src attribute and refresh using a realtime channel

What?

A summary of the purpose of this piece of software, for example: Delivery of Learnosity assessments to students and reporting student results to teachers.

Diagram

You'll need

• Redis
• MySQL

bin/setup
rails db:create
rails db:migrate
rails db:seed

http://localhost:3000/posts/1

rake comments:create
rake comments:clear

Where?

Links

A list of links to deployed software For example:

• stage: stage-project.strongmind.com
• prod: project.strongmind.com

CI/CD

A link to CI/CD for this repository For example:

• https://github.com/StrongMind/project/actions

Administration

A list of links to operational information, for example:

• Logs
• Exception Tracking
• Monitoring & Metrics Dashboard

Local Install

A set of comprehensive instructions to install from scratch on a developer workstation. We suggest you test these with a member from another team. For example:

Mac

In this source directory:

1. Install homebrew
2. Install python 3.10 using homebrew brew install [email protected]
3. Install virtualenv and virtualenvwrapper pip install virtualenv virtualenvwrapper
4. Create virtual environment for project mkvirtualenv project_name -p /opt/homebrew/opt/[email protected]/bin/python3
5. Install project requirements pip install -r requirements.txt

Known Issues and Fixes

If your system python does not include pip, you will need to make sure pip is installed :

python -m ensurepip # if your system python is at least 3.4

If your system python isn't at least 3.4, you will need to use your system package manager to install pip.

Windows

In this source directory:

1. Install python
2. Open project in pycharm
3. Set interpreter installed python 3.10
4. Open shell
5. Install project requirements pip install -r requirements.txt

Run tests locally

A set of instructions to run tests locally, for example:

pytest

Run service locally

A set of instructions to run service locally, for example:

Mac (service)

python manage.py runserver

Windows (service)

py manage.py runserver

Code owners can be found in CODEOWNERS file