Skip to content

Latest commit

 

History

History
189 lines (131 loc) · 5.33 KB

README.md

File metadata and controls

189 lines (131 loc) · 5.33 KB
Raw

Contributors Forks Stargazers Issues

#LifeStyle Articles

This project is the Capstone of the Microverse curriculum at the end of the Ruby on Rails module!
Explore the docs »

Report Bug · Request Feature

Table of Contents

About The Project

This is the Capstone project that signs the completion of the RubyOnRails module in the Microverse Curriculum. It is a web app where users can register using their name, username, password and can sign in with their username only. As a logged-in user, it is possible to create articles, edit profiles, comment, vote and bookmark an article for future reads. The app can be used also on read-only mode, with restricted access to its features.

Built With

This project was built using these technologies.

  • Ruby & Ruby on Rails
  • Rspec / Capybara
  • Bootstrap
  • HTML / CSS / SCSS
  • SQLite
  • Rubocop
  • GithubActions 💪
  • Atom :atom:

Walkthrough Deployment (Heroku)

Getting Started

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

Prerequisites

Ruby: 2.6.6 Rails: 5.2.4

Clone

  • download or clone this repo:
    • Clone with SSH:
      [email protected]:arslanbisharat/lifestyle-articles.git
    • Clone with HTTPS
      https://github.com/arslanbisharat/lifestyle-articles.git

Setup

Install gems with:

$ bundler install --without production

Setup database with:

$ rails db:migrate
$ rails db:seed

Usage

Start server with:

$ rails server

Open http://localhost:3000/ in your browser and sing in with a user already defined --> 👉 maxinova 👈

  • for any technical problems running rails db:migrate:reset && rails db:seed should solve it

Create User

Fill the signup form to create a user

screenshot

Login

Use only the username to login

screenshot

Create a new article from the dropdown menu

Type your title and text, add an image, category, and a tag

screenshot

Bookmarked articles

Articles can be bookmarked and will be saved in `Your Bookmarks

screenshot

Edit User Profile

User profile can be edited along with the profile's picture

screenshot

Automated Test

  • Run the command and see the output: $ bundle exec rspec Rspec

Database Structure

  • Database schema used for this project reflects the following structure: erd

Potential future features

  • Extend the signin / signup process to social accounts, use verified email process
  • Improve the front-end

Contributors

🤝 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!

Acknowledgements

Credits

📝 License

This project is MIT licensed.