/Ruby-on-Rails-Article-web

Article's website that will let users read and post articles. Made with Ruby on Rails.

Primary LanguageRuby

Contributors Issues

Here you can put a header picture

Articles project

Web app that lets you create articles (RoR ♦️)
Explore the docs »

Ruby on Rails Articles project

A website concept that will let users read and write articles, after creating an account, users can post and rate them. Made with Ruby on Rails and deployed to Heroku.

Index

Built With

  • Ruby v2.6.5
  • Ruby on Rails v5.2.4
  • Webpack
  • SASS (for grid structure)
  • HTML/CSS

Installation

Prerequisites

Ruby: 2.6.3 Rails: 5.2.3 Postgres: >=9.5


bundle install

Setup database with:

   rails db:create
   rails db:migrate

Usage

Start server with:

    rails server

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

Open https://immense-plains-60294.herokuapp.com/ in your browser.

Live Demo

https://articles-posting.herokuapp.com/

Testing

Unit test was used on this project for testing models and controllers RSpec was used for testing login - account creation - article creation and vote action.

    run rails test for testing on console
    run rails test -v to see verbose version (showing what is testing)
    run bundle exec rspec for running integration test written on RSpec
    run bundle exec rspec spec --format documentation to read the test that will
    be running for rspec.

    Small article creation integration test was also written in unit-test

Read below if a test error showed !

Bugs you may find !

Anything weird happening somewhere that you wish to report it, please do while stating how to replicate this bug, what did you tried to do and what message (if any) did appear. Thank you ! 💚 💚

Contact📱

Future Improvements

  • Update on UI
  • Add rich text format to the article creation action.

Feel free to check the issues page for issues and proposed features.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT