Merging completed v0.1.0 version of rails blogger into master. Check commit history for additional info

Author: Rhelli

Gemfile

@@ -3,6 +3,12 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 ruby '2.6.5'
 
+# Paperclip as per TOP specifications
+gem 'paperclip'
+
+# Sorcery for simple  authentication
+gem 'sorcery'
+
 # Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
 gem 'rails', '~> 5.2.3'
 # Use sqlite3 as the database for Active Record

Gemfile.lock

@@ -47,6 +47,7 @@ GEM
     archive-zip (0.12.0)
       io-like (~> 0.3.0)
     arel (9.0.0)
+    bcrypt (3.1.13)
     bindex (0.8.1)
     bootsnap (1.4.5)
       msgpack (~> 1.0)
@@ -64,6 +65,7 @@ GEM
     chromedriver-helper (2.1.1)
       archive-zip (~> 0.10)
       nokogiri (~> 1.8)
+    climate_control (0.2.0)
     coffee-rails (4.2.2)
       coffee-script (>= 2.2.0)
       railties (>= 4.0.0)
@@ -75,6 +77,8 @@ GEM
     crass (1.0.6)
     erubi (1.9.0)
     execjs (2.7.0)
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
     ffi (1.12.2)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
@@ -83,6 +87,7 @@ GEM
     io-like (0.3.0)
     jbuilder (2.9.1)
       activesupport (>= 4.2.0)
+    jwt (2.2.1)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -95,14 +100,33 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (0.9.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
     mimemagic (0.3.4)
     mini_mime (1.0.2)
     mini_portile2 (2.4.0)
     minitest (5.14.0)
     msgpack (1.3.3)
+    multi_json (1.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
     nio4r (2.5.2)
     nokogiri (1.10.7)
       mini_portile2 (~> 2.4.0)
+    oauth (0.5.4)
+    oauth2 (1.4.3)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    paperclip (6.1.0)
+      activemodel (>= 4.2.0)
+      activesupport (>= 4.2.0)
+      mime-types
+      mimemagic (~> 0.3.0)
+      terrapin (~> 0.6.0)
     public_suffix (4.0.3)
     puma (3.12.2)
     rack (2.1.2)
@@ -153,6 +177,10 @@ GEM
     selenium-webdriver (3.142.7)
       childprocess (>= 0.5, < 4.0)
       rubyzip (>= 1.2.2)
+    sorcery (0.14.0)
+      bcrypt (~> 3.1)
+      oauth (~> 0.4, >= 0.4.4)
+      oauth2 (~> 1.0, >= 0.8.0)
     spring (2.1.0)
     spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
@@ -165,6 +193,8 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
+    terrapin (0.6.0)
+      climate_control (>= 0.0.3, < 1.0)
     thor (1.0.1)
     thread_safe (0.3.6)
     tilt (2.0.10)
@@ -197,10 +227,12 @@ DEPENDENCIES
   coffee-rails (~> 4.2)
   jbuilder (~> 2.5)
   listen (>= 3.0.5, < 3.2)
+  paperclip
   puma (~> 3.11)
   rails (~> 5.2.3)
   sass-rails (~> 5.0)
   selenium-webdriver
+  sorcery
   spring
   spring-watcher-listen (~> 2.0.0)
   sqlite3

README.md

@@ -1,24 +1,98 @@
-# README
+# 📑 Blogger Web App - Ruby on Rails
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
+This is another, quick project devised to practice the basics of creating Rails web apps. This time, it's a blog. However, unlike my previous [Rails blog app](https://github.com/Rhelli/Simple-Rails-Blog), this blog is a little more complex. It possesses all the features you might expect from a web blog (or any other rails based web app), at an entry level perspective.
 
-Things you may want to cover:
+## 🖱️ The Project Brief
 
-* Ruby version
+The specifications and the guide to the project can be found on the ['Getting Started with Rails'](https://guides.rubyonrails.org/getting_started.html) page from [guides.rubyonrails.org](https://guides.rubyonrails.org/).
 
-* System dependencies
+The scope of this project covers:
+  - Articles
+    - Create, edit and delete
+    - Index, show, edit and new pages
+    - Ability to upload various image formats with articles (jpeg, png, gif)
+  - Authors (users)
+    - Create, edit and delete
+    - Index, show and edit pages
+  - Tags
+    - Create, edit and delete
+    - Associate/Tag articles on their creation
+    - An index page of all Tags to browse articles by Tag name
+  - Comments
+     - Create edit or delete comments on their respective article's page
+     - Timestamp for 'how long ago' comments were posted
+  - Authentication
+    - Protection of creation, editing and deleting user accounts, articles, tags and comments unless signed in
+    - User account and article creation is open only to those signed in
+    - Basic email and HTTP password authentication
 
-* Configuration
+******
 
-* Database creation
+## Showcase
 
-* Database initialization
+<a href="app/assets/articles-screen.gif"><img src="app/assets/articles-screen.gif" alt="Articles Screen" width="800" height="464"></a>
 
-* How to run the test suite
+> Browsing articles from the 'index' page and navigating to the articles 'show' page.
 
-* Services (job queues, cache servers, search engines, etc.)
+<a href="app/assets/authors-screen.gif"><img src="app/assets/authors-screen.gif" alt="Authors Screen" width="800" height="464"></a>
 
-* Deployment instructions
+> Logging in provides the user with additional options, such as editing and deleting articles, as well as creating them.
 
-* ...
+<a href="app/assets/create-article-screen.gif"><img src="app/assets/create-article-screen.gif" alt="Create Article Screen" width="800" height="464"></a>
+
+> Once logged in, users can create articles, add images to the articles and add comments.
+
+<a href="app/assets/tags-screen.gif"><img src="app/assets/tags-screen.gif" alt="Tags Screen" width="800" height="464"></a>
+
+> Users can browse through articles via Tags and can delete tags when they are logged in.
+
+******
+
+## 💪🏽 Technologies, Languages & Gems Used
+
+- Ruby 2.6.5
+- Ruby on Rails 5.2.4.1
+- CSS3
+- SCSS
+
+- Sorcery - Used for generation of security & authentication models, controllers and views
+- Paperclip - Facilitated image upload to articles from local env
+- Imagemagick - Formatting of images for upload to blog
+
+## 🔑 Setup & Usage
+If you want to poke around or modify this web app, you'll have to first follow a couple of steps to ensure everything runs right.
+### System Requirements
+First off, you'll need the following:
+ - Ruby
+ - Ruby on Rails
+If you're not sure what either of those is or need pointing in the right direction [this right here](https://www.ruby-lang.org/en/documentation/installation/), is the best place to head.
+
+### Usage
+1. After you have this repository downloaded and you've made sure Ruby and Ruby on Rails are updated and on your machine `cd` into this repository, wherever it is you downloaded it to. [Not sure what 'cd' means?](https://www.git-tower.com/learn/git/ebook/en/command-line/appendix/command-line-101)
+2. Once you've `cd` into this repo, type in the command `bundle install`. This will download all the required Ruby Gems for the web app so it can function properly. [Not sure what Ruby Gems Are?](https://guides.rubygems.org/)
+3. Once the `bundle` install command above has finished downloading, ensure you are in this repository's root directory and enter the command `rails server` into your terminal. This will start the Ruby on Rails server, allowing you to now access it from your browser of choice.
+4. Type in `http://localhost:3000/` into your browser address bar and hit enter. You should now see the Rails Blog App!
+5. To access the different pages available, enter the following:
+      - localhost:3000/articles
+      - localhost:3000/authors
+      - localhost:3000/tags
+6. Please be aware that some of these pages do not have full functionality unless you are logged in. To test this, please use the following `email: admin@example.com password: admin`.
+
+## 🤲🏽 Contributions, Issues and Forking
+
+If you have any issues setting up the project or you come across any unintended bugs or problems, please do submit an issue to the [Rails Blogger Issue Page](https://github.com/Rhelli/Rails-Blogger/issues)
+
+If you want to make your own changes, modifications or improvements, go ahead and Fork it!
+1. Fork it (https://github.com/Rhelli/Rails-Blogger/fork)
+2. Create your working branch (git checkout -b [choose-a-name])
+3. Commit your changes (git commit -am 'what this commit will fix/add/improve')
+4. Push to the branch (git push origin [chosen-name])
+5. Create a new Pull Request
+
+## 👨🏽‍💻 Creator
+
+Rory Hellier - [GitHub](https://github.com/Rhelli)
+
+## 📣 Show Your Support
+
+Give a ⭐️ if you like this project!

app/assets/images/articles-screen.gif

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

app/assets/images/authors-screen.gif

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

app/assets/images/create-article-screen.gif

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/