/emerald-jabs

Full Stack Rails Learning Management System

Primary LanguageRubyMIT LicenseMIT

Emerald

ea_img Emerald is an online learning management system application. This project came about as a group effort between three other developers and myself.

Table of Contents

  1. Getting Started
  2. Technology
  3. Installation
  4. Features
  5. Contributing
  6. Author
  7. License

Getting Started

Initial software environment conditions

Technology

PostgreSQL: SQL database used to store user, sessions, documents, images, posts and comments
Rails: Full-stack framework used to create server, connect to database and serve up dynamic HTML content
Active Storage: Used for cloud storage of uploaded files
Quill Editor: Provided in-browser rich text editor
Prawn: Convert HTML to PDF
Devise: User registration and session setup
Bootstrap: Reliable CSS framework used to quickly add UI components and responsiveness to application

Installation

$ gpg2 --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB

$ \curl -sSL https://get.rvm.io | bash -s stable
  • Install Ruby
$ rvm install ruby-2.5.3

$ rvm use ruby-2.5.3
  • Install Bundler
$ gem install bundler --no-rdoc --no-ri
  • Install Rails
$ gem install rails -v 5.2.2 --no-rdoc --no-ri
  • Create Rails Project With PostgreSQL DB
$ rails new <app name> --database=postgresql

$ cd <app name directory>/
  • Install Remaining Tech Stack
$ gem install pg devise activestorage twitter-bootstrap-rails prawn

Features

  • Authentication
  • Sessions
  • Rich Text Editor
  • Embedded PDF Viewer
  • File & Image Upload
  • Posting
  • Commenting
  • Calculator

Contributing

Pull requests are welcome. Please read CONTRIBUTING.md for more details.

Author

I encourage you to explore the profiles and some of the projects created by these talented developers 😃!

License

MIT