Skip to content

Latest commit

 

History

History
71 lines (43 loc) · 2.15 KB

README.md

File metadata and controls

71 lines (43 loc) · 2.15 KB

Articles

A simple web app for publishing articles

It's Ruby on Rails Capstone project of Microverse, which students have to build a real-world-like project with business specifications. Students are given 5 days to build the project upon receiving the project specifications.

This project follows the best practices , like setting-up a code linter, using gitflow testing business logic, writing good commit messages and an informative README.

It's inspired by Microverse's curriculum structures, where students have to write articles for each section as requirements of the software development program.

This project is built with Ruby On Rails and a little JavaScript.

Live Links & Walkthrough Video

Project Snapshots

image

Built With

  • Ruby on Rails
  • JavaScript
  • RSpec

Testing

  1. Clone the project and cd to private-events
  2. Run yarn install --check-files to check and update yarn packages
  3. Run 'rspec'
  4. 10 examples, 0 failures should be shown.

Deployment

  1. Git clone this repo and cd the to the articles directory.
  2. Run bundle install in command line to install gems.
  3. Run rails db:setup to migrate and seed database.
  4. Run rail s and open browser with http://localhost:3000/.
  5. You shall see the root page as the picture above.

Main Features

  1. Dark/Light mode toggling.
  2. Most voted article as featured.

Authors

👤 Kyle Law

🤝 Contributing

Contributions, issues and feature requests are welcome!

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

This project is MIT licensed.