|
1 | | -# README |
| 1 | +# π Blogger Web App - Ruby on Rails |
2 | 2 |
|
3 | | -This README would normally document whatever steps are necessary to get the |
4 | | -application up and running. |
| 3 | +This project is part of a series of projects to be completed by students of [Microverse](https://www.microverse.org/ 'The Global School for Remote Software Developers!'). |
5 | 4 |
|
6 | | -Things you may want to cover: |
| 5 | +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. |
7 | 6 |
|
8 | | -* Ruby version |
| 7 | +The scope of this project covers: |
| 8 | + - Articles |
| 9 | + - Create, edit and delete |
| 10 | + - Index, show, edit and new pages |
| 11 | + - Ability to upload various image formats with articles (jpeg, png, gif) |
| 12 | + - Authors (users) |
| 13 | + - Create, edit and delete |
| 14 | + - Index, show and edit pages |
| 15 | + - Tags |
| 16 | + - Create, edit and delete |
| 17 | + - Associate/Tag articles on their creation |
| 18 | + - An index page of all Tags to browse articles by Tag name |
| 19 | + - Comments |
| 20 | + - Create edit or delete comments on their respective article's page |
| 21 | + - Timestamp for 'how long ago' comments were posted |
| 22 | + - Authentication |
| 23 | + - Protection of creation, editing and deleting user accounts, articles, tags and comments unless signed in |
| 24 | + - User account and article creation is open only to those signed in |
| 25 | + - Basic email and HTTp password authentication |
9 | 26 |
|
10 | | -* System dependencies |
| 27 | +## π±οΈ The Project Brief |
11 | 28 |
|
12 | | -* Configuration |
| 29 | +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/). |
13 | 30 |
|
14 | | -* Database creation |
| 31 | +## πͺπ½ Technologies, Languages & Gems Used |
15 | 32 |
|
16 | | -* Database initialization |
| 33 | +- Ruby 2.6.5 |
| 34 | +- Ruby on Rails 5.2.4.1 |
| 35 | +- CSS3 |
| 36 | +- SCSS |
17 | 37 |
|
18 | | -* How to run the test suite |
| 38 | +- Sorcery - Used for generation of security & authentication models, controllers and views |
| 39 | +- Paperclip - Facilitated image upload to articles from local env |
| 40 | +- Imagemagick - Formatting of images for upload to blog |
19 | 41 |
|
20 | | -* Services (job queues, cache servers, search engines, etc.) |
| 42 | +## π¨π½βπ» Creator |
21 | 43 |
|
22 | | -* Deployment instructions |
| 44 | +Rory Hellier - [GitHub](https://github.com/Rhelli) |
23 | 45 |
|
24 | | -* ... |
| 46 | +## ππ½ Show Your Support |
| 47 | + |
| 48 | +Give a βοΈ if you like this project! |
0 commit comments