bryanjeanty/the-watchman

TV show discussion blogging application built with Sinatra

The Watchman

The Watchman is a multi-user TV show discussion application.

Table of Contents

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

Getting Started

Initial software environment conditions

• Version Manager - RVM
• Package Manager - GEMS (Installed with Ruby)
• Code Editor - VS Code, Atom, Sublime Text, etc.
• Operating System - MAC OS, Windows or any Linux Distro
• Modern Browser - Google Chrome or Firefox

Technology

PostgreSQL: SQL database used to store user, posts and comments
Sinatra: Ruby-based microframework to create server, connect to database and serve up dynamic HTML
Active Record: Relational database object-relational mapper for sinatra framework
CSS: Application-level styling and customization
JavaScript: Application UI functionality

Installation

• Install RVM

$ 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 Remaining Tech Stack

$ gem install pg sinatra activerecord sinatra-activerecord

Features

• Authentication
• Posting
• Commenting

Contributing

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

Author

• Bryan Jeanty

License

MIT