Skip to content

Latest commit

 

History

History
362 lines (267 loc) · 11.6 KB

README.md

File metadata and controls

362 lines (267 loc) · 11.6 KB

polylingo

Open source educational software design, supported by multi-lingual teaching and learning.

  • Collaborative Web App Prototyping Teams = [Developers+Instructors+Students] => [Design+Test+Build+Deploy]

Table of Contents

Mile High Overview

  • Devs
    • Setup Local Dev Environment + Stand Up App As Is.
    • Setup Local Deployment Tooling + Redeploy To Heroku.
    • Setup Local System For Redeploying To Your Own Heroku App Hosting.
    • Add Example Local Feature: [ Test + Code + Tag ].
    • Redeploy Enhanced Demo To Self-Hosted Heroku.
    • Invite Instructors To Private Test-Driven Feature Demo.

Broaden scope of project grasp => Detailed Overview

Skim this before your test-drive => Web App Prototype Feature Requests

  • Instructors & Students
    • Test-Drive Public Demo Web App + Foundational Features

Run Web App Demo For Prototyping

  • Publicly Hosted Web Demo
    • Connect and review supported languages.
    • Login as Guest. Register.
    • Logout. Login.
    • Choose Languages Of Interest.
    • Reflect On Test-Driven Feature Development

Installing Instructions and setting up the project

Step 1: Install RVM

In Terminal RUn: sudo apt-add-repository -y ppa:rael-gc/rvm sudo apt-get update sudo apt-get install rvm

Step 2: Installing ruby version

RUN: rvm install ruby 2.5.1

Step 3 - Configure Ruby Gem

gem update --system gem -v

Step 4 - Install Ruby on Rails

gem install rails -v 6.1.4.1 After the installation is complete, check the rails version.

rails -v

Step 5 - Setup PostgreSQL Database for Rails Development

sudo apt install postgresql postgresql-contrib libpq-dev -y After all installation is complete, start the Postgres service and enable it to launch everytime at system boot.

systemctl start postgresql systemctl enable postgresql Next, we will configure a password for the Postgres user, and create a new user for the Rails installation.

Login to the 'postgres' user and run the Postgres shell.

su - postgres psql Change the Postgres password using the query below.

\password postgres Type your password and the password for postgres user has been added.

Now we will create a new role for our rails installation. We will create a new role named 'rails_dev' with the privilege of creating the database and with the password 'aqwe123'.

Run the Postgres query below.

create role rails_dev with createdb login password 'aqwe123';

Step 6 - installing bundler

Got to your project folder in terminal and RUN:

gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)"

Step 7

run: bundle install

Step 8

Run: rake db:setup

project setup successfully

to run the project:

Run: rails s

Local Dev Setups

Local Dev Testing

Heroku Remote Hosting Local Setups

  • Assumes basic familiarity with Ruby/Rails and Git.
  • Requires locally installed version of Ruby 2.5.0+, Rubygems, Bundler, and Rails 6+
  • Requires heroku user account link
  • Install the Heroku CLI on your development machine.
  • Once installed, the heroku command is available from your terminal. $ heroku -help
  • Log in using your Heroku account’s email address and password: $ heroku login
    • Enter your Heroku credentials
      • Email: < heroku account email >
      • Password: < heroku account password >

Heroku Remote Service Deployment

Deploy your application to Heroku
  • Make sure you are in the directory that contains your Rails app, then create an app on Heroku: $ heroku create <your app name>
Verify deployment

  • Remote heroku target was added to your project by running: $ git config --list --local | grep heroku

  • If you see 'fatal: not in a git directory' then you are likely not in the correct directory. Otherwise, you can deploy your code.

  • Deploy your code to heroku under your own account using: $ git push heroku master

  • After deploying code, we need to migrate our database, make sure it is properly scaled, and use logs to debug any issues that come up. To push branch other than master use the following command: $ git push heroku <your-branch-name>:master

Migrate your database If you are using the database in your application, you need to manually migrate the database by running: $ heroku run rake db:migrate Any commands after the heroku run are executed on a Heroku dyno. You can obtain an interactive shell session by running: $ heroku run bash We can now visit the app in our browser with command: $ heroku open

Troubleshooting

  • Local Setups + Testing

  • Heroku Setups + Deployments

    • Complete Heroku CLI Docs
    • If you run into any problems getting your app to perform properly, then you will need to check the logs.
      • View information about your running app using one of the logging commands: $ heroku logs -t
    • Run the Rails console.
      • Heroku supports a one-off "dyno" using the heroku run command.
    • To launch a Rails console process attached to your local terminal for experimenting in your app’s environment: $ heroku run rails console

Types of Contributors

  • Adoptors In Education
    • Instructors
    • Students
  • Ruby on Rails 6.x Devs
  • Ruby Sinatra Devs
  • React + Node Devs
  • Elixir + Phoenix Devs
  • PHP + Symfony Devs
  • Python3 + Flask Devs

Tools For Seasoned Developers

Task Management

  • Product Team Roles: Product Manager + Technical Project Managers + Instructors + Developers + Engineers + Docs + APIs
  • Issue Types
  • Issue Triage
  • Issue Templates
  • PR Types
  • PR Triage
  • PR Templates
  • Tech Workflows
  • Educational Workflows
  • Current + Pending Tasks => Move to issues!!

Related Projects

References

These days, web apps are mostly built from...

  • microsoft and other proprietary software
  • wordpress, drupal (php)
  • ruby on rails
  • python flask or django
  • java etc
  • node react
  • ruby sinatra
  • elixir

Each of the items above can be represented with 1-2 icons. That lends itself to web diagramming. We use http://diagrams.net for that.

Proposed format of tech README.md doc...

  • Project Title: polylingo

  • Repository Title: polylingo

  • Description: multilingual solutions for teaching and learning

  • Demo URL

  • Demo Instructions

  • User Demo Support Requests

  • User Demo Feature Requests

  • Audiences

  • Issue Types

  • Install Deps For Local App Setup

  • Clone + Stand Up Local App

  • Local App Dev Debugging

  • Local App Dev Prototyping

  • Deploy To Heroku

  • Pull Requests

  • Automate Deployments

  • Dockerize Dev Env

  • Automate Dockerization + k8sDeploys

  • Gitpods For Dev Env

  • Building Teams

Dev Languages + Frameworks:

  • ruby-rails
  • elixir-phoenix
  • node-react
  • python-flask
  • flutter mobile

Next Steps

  • updating rails to latest vers
  • resolving gem issues
  • deployment on heroku
  • test docs
  • split {Poly,Uni}Lingo