This project is a Lifestyle Articles Web application built with rails. It implements the basic functionality found on the popular lifestyle websites. It's a website where writers can write on things they care about based on the article categories.
- About the Project
- Live Preview
- Data Architecture Documentation (ERD)
- Required Installations
- Instalation of This App
- License
- Contact
- Acknowledgements
This project is a Lifestyle Articles web application. In this project, users can sign up using their usernames only. Once a user becomes a member, such a user can be able to create articles for readers to read, edit their profile, comment on articles. That user can also vote for articles and bookmark articles for future reads. A reader can use the app whether he/she is a member or not but is limited to features they can access. Such a reader can only read and comments on other articles. The main goal is to build a full-fledged web app in real-time and also practice the main concepts of MVC, Model Associations, Session Authentications with bcrypt, and perform units & integration testing with RSpec and Capybara.
- HTML
- CSS
- Git
- Ruby
- Ruby on Rails
This is the link to the live preview in Heroku. Feel free to visit.
Sleezy - Lifestyle Articles Web App
Below are the HomePage Screenshots
- Users can signup/login and create articles to publish.
- Users can save articles for future editing.
- Users can vote an article.
- Users can bookmark articles for future reads.
- Readers/Users can comment on articles.
- Users can search for articles by their titles.
- Images are hosted in Amazon S3 cloud storage on production.
The image below is a copy of the Entity Relationship Diagram generated for this project.
If you want a copy of this project running on your machine you have to install:
- Ruby 2.6.4
- Gem 3.0.3
- Rails 6.0.2
- Bundler 2.0.2
Once you have installed the required packages shown on the Required Installations, proceed with the following steps
Clone the Repository,
your@pc:~$ git clone https://github.com/adaorachi/lifestyle-articlesMove to the downloaded folder
your@pc:~$ cd lifestyle-articlesinstall gems
your@pc:~$ bundle install --without productioncreate, migrate and seed the database
your@pc:~$ rails db:createyour@pc:~$ rails db:migrateyour@pc:~$ rails db:seedIf you run into any problem while performing any of the last three commands, running the following command will drop the database and initialize those commands automatically.
your@pc:~$ rails db:resetFinally, run the app in a local server:
your@pc:~$ rails serverThen, go to http://localhost:3000
For security purposes, one admin user will be automatically generated when you seed the database. The admin will have all privileges and exclusive rights to perform some actions such as creating the categories. Login details are as follows:
username: johndoe
password: admin123
You can choose to change your username and password once you are logged in.
To run the unit test, follow these steps.
Open a terminal
Install the rspec gem if you have not already
your@pc:~$ gem install rspecRun RSpec in the terminal
your@pc:~$ rspecSome of the features or improvements I would like to implement on this project is to add more unit test to the test suite.
Distributed under the MIT License. See LICENSE for more information.
- MaryAnn Chukwuka - annychuks07@gmail.com | Github Account https://github.com/adaorachi
I would like to credit Nelson Sakwa for his Behance design ideas which I used in creating this app. The project's color, typography, and layouts were gotten from this design. The design can be seen . I love the design.