Skip to content

Commit 2e460b7

Browse files
committed
Updated db with a new article, added readme. Needs demo videos
1 parent c6b9e6f commit 2e460b7

File tree

6 files changed

+37
-13
lines changed

6 files changed

+37
-13
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 37 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,48 @@
1-
# README
1+
# πŸ“‘ Blogger Web App - Ruby on Rails
22

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!').
54

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.
76

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
926

10-
* System dependencies
27+
## πŸ–±οΈ The Project Brief
1128

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/).
1330

14-
* Database creation
31+
## πŸ’ͺ🏽 Technologies, Languages & Gems Used
1532

16-
* Database initialization
33+
- Ruby 2.6.5
34+
- Ruby on Rails 5.2.4.1
35+
- CSS3
36+
- SCSS
1737

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
1941

20-
* Services (job queues, cache servers, search engines, etc.)
42+
## πŸ‘¨πŸ½β€πŸ’» Creator
2143

22-
* Deployment instructions
44+
Rory Hellier - [GitHub](https://github.com/Rhelli)
2345

24-
* ...
46+
## πŸ‘πŸ½ Show Your Support
47+
48+
Give a ⭐️ if you like this project!
75.4 KB
Loading
75.4 KB
Loading
72.2 KB
Loading
22.3 KB
Loading
2.03 KB
Loading

0 commit comments

Comments
Β (0)