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, 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.
The specifications and the guide to the project can be found on the 'Getting Started with Rails' page from guides.rubyonrails.org.
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
Browsing articles from the 'index' page and navigating to the articles 'show' page.
Logging in provides the user with additional options, such as editing and deleting articles, as well as creating them.
Once logged in, users can create articles, add images to the articles and add comments.
Users can browse through articles via Tags and can delete tags when they are logged in.
-
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
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.
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, is the best place to head.
- After you have this repository downloaded and you've made sure Ruby and Ruby on Rails are updated and on your machine
cdinto this repository, wherever it is you downloaded it to. Not sure what 'cd' means? - Once you've
cdinto this repo, type in the commandbundle install. This will download all the required Ruby Gems for the web app so it can function properly. Not sure what Ruby Gems Are? - Once the
bundleinstall command above has finished downloading, ensure you are in this repository's root directory and enter the commandrails serverinto your terminal. This will start the Ruby on Rails server, allowing you to now access it from your browser of choice. - Type in
http://localhost:3000/into your browser address bar and hit enter. You should now see the Rails Blog App! - To access the different pages available, enter the following:
- localhost:3000/articles
- localhost:3000/authors
- localhost:3000/tags
- 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: [email protected] password: admin.
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
If you want to make your own changes, modifications or improvements, go ahead and Fork it!
- Fork it (https://github.com/Rhelli/Rails-Blogger/fork)
- Create your working branch (git checkout -b [choose-a-name])
- Commit your changes (git commit -am 'what this commit will fix/add/improve')
- Push to the branch (git push origin [chosen-name])
- Create a new Pull Request
Rory Hellier - GitHub
Give a ⭐️ if you like this project!