/blog

Primary LanguageRubyMIT LicenseMIT

Microverse

Ruby Shell Script Postgres Rails

Blog 🗒️💡✏️❤️

This repo holds a simple blog website app built with ROR. The website shows the list of posts and empowers readers to interact with them by adding comments and liking posts.

Database ERD Diagram 📝

Built With 🛠️

  • Ruby Popular programming language that’s used for lots of things, from web app development to data analysis.
  • GitHub flow: Correct use of Branches for deployment and features development.
  • Linters Check (Rubocop & Stylelint): Local and Pull Request check for errors, bugs and stylistic errors in code.
  • PostgreSQL: A powerful, open source object-relational database system.
  • Rails: A web application development framework written in the Ruby programming language. This app currently implements version 7.0.4

Getting Started ➡️

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

  • Check the Ruby version or if you have at all by running ruby -v if it returns ruby 3.1.2p20 (2022-04-12 revision 4491bb740a) or similar, you have Ruby installed.
  • Ruby version used ruby 3.1.2

Setup 🛠️

  • Clone the repository using the GitHub this link 🔗
  • cd blog
  • Run bundle install
  • Run rails server
  • Open Browser http://localhost:3000/
  • Ensure you have PostgreSQL installed before running the applicationpsql --version.
  • Run rails db:create.
  • Create a .envs file using the link to host postgres credentials.

Testing

To run tests:

  • Ensure you have RSpec installed: running bundle install will install it since it is included in the Gemfile.
  • To run a specific test:
  • Run rspec spec/models<name_of_spec_file>
  • To run all tests:
  • Run rspec spec

Authors ✍️

👩‍💻 Rodrigo Johann Reckziegel Nunes ✍️

Project Milestones 📌

  • Milestone 1: Creating a data model. ⚙️
  • Milestone 2: Validations and Model specs. ⚙️
  • Milestone 3: Processing data in models. ⚙️
  • Milestone 4: Setup and controllers. ⚙️
  • Milestone 5: Controllers specs. ⚙️
  • Milestone 6: Views. ⚙️
  • Milestone 7: Forms. ⚙️
  • Milestone 8: Integration specs for Views and fixing n+1 problems. ⚙️
  • Milestone 9: Add Devise. ⚙️
  • Milestone 10: Add authorization rules. ⚙️
  • Milestone 11: Add API endpoints. ⚙️
  • Exercise: API documentation. ⚙️

🤝 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

  • Hat tip to anyone whose code was used
  • Microverse staff
  • Inspiration
  • etc

📝 License

This project is MIT licensed.