Skip to content

Latest commit

 

History

History
138 lines (89 loc) · 3.98 KB

README.md

File metadata and controls

138 lines (89 loc) · 3.98 KB
Raw

Rails Capstone: Lifestyle Articles

This repo holds the ruby on rails capstone project inspired by microverse.org & creativecommons.

Capstone projects are solo projects at the end of each of the Microverse Main Technical Curriculum sections. They are meant to give the author the knowledge & real-world working experience through the business specifications which are included in the project requirements. The capstone project is a way of assessing the author's abilities to work with technologies that they acquired under a certain section of the Main Technical Curriculum ( Ruby on Rails in this case ).

This application is based on lifestyle articles website. I developed it following the creativecommons design. The main goal was to come up with an application that looks as the one in the design. As an optional requirement, I personalized the content to build an application ( Siblife ) which is a site where consumers can post, vote & read on articles. The app is a desktop application, it does not resize perfectly on small screens. Users can create accounts to vote & write articles or readmore about a certain article.

To sign up, users are required to use their name, which they will also use for signing in. It's not in the requirements of the project, but I had to add more fields on the signup/signin pages for better presentation & style. To view the app, visit the link below under the Live Demo section & play with it.

To set up the project on your local machine, follow the instructions below. Please give a start if you like the project.

Built With

  • Sass (.scss)
  • Bootstrap
  • Ruby v2.7.0
  • Ruby on Rails v6.0.3
  • rails-rspec
  • rubocop
  • stylelint
  • cloudinary
  • carrierwave

Image storage:

As for images, I configured my development, test, & production environment to use cloudinary. You can follow this tutorial written by @brana on how you can configure your environments to use cloudinary storage for storing your images. It's free.

Live Demo

Siblife livedemo

Homepage ScreenShot

screenshot

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

Ruby: 2.7.0 Rails: 5.2.3 Postgres: >=9.5

Additional gems:

  • carrierwave
  • cloudinary

Setup

Clone the project & start work on your local environment by running:

git clone https://github.com/ClaytonSiby/RoR-Capstone-Lifestyle-articles.git

And change directory with cd RoR-Capstone-Lifestyle-articles

Install gems with:

bundle install

Add Bootstrap dependencies by running:

yarn add bootsrap jquery popper.js

or

  yarn install

To setup database run:

  rails db:migrate

Usage:

Start server with:

    rails s

Open http://localhost:3000/ in your browser.

Run tests:

  • for all files:
    bundle exec rspec
  • for single file:
    bundle exec rspec spec/name_of_spec.rb

Author

👤 Clayton Siby

🤝 Contributing

Contributions, issues and feature requests are welcome! Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

  • Nelson Sakwa

Stackoverflow

Odin Project

getbootstrap.com

w3schools

Rails Community

Microverse.org

📝 License

creativecommons