📗 Table of Contents

• 📗 Table of Contents
• 📖 Inkling Blog
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 📝 License

📖 Inkling Blog

The Inkling Blog app is a classic blog website. It is a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

Here are the tech stacks applied in this project.

Language

• Ruby
• JavaScript

Framework

• Ruby on Rails

Database

• PostgreSQL

Linters

• Rubocop
• Stylelint

Markup Languages

• HTML5
• CSS3

Test Library

• RSpec

(back to top)

Key Features

This app has the following key features:

• Create new blog user.
• Post articles and gists on the blog.
• Comment on articles of the blog.
• Like articles and comments on the blog.
• View users, articles, comments and likes of the blog.

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need:

• Install Ruby on your computer (machine)

Setup

Clone this repository to your desired folder:

  git clone [email protected]:PraisesPJMT/Inkling-Blog-App.git
  cd Inkling-Blog-App

Install

Install this project with:

  gem install bundler
  bundle install

Usage

To run the project, execute the following command:

  rails server

• After running rails server, use the app on http://localhost:3000/ in the browser!
• For more information please visit Ruby-on-Rails.

(back to top)

👥 Authors

👤 Praises Tula

👤 Moathal Kachi

(back to top)

🔭 Future Features

These are features that will be add to the project.

• Creating a data model
• Processing data in models
• Validations and Model specs
• Setup and controllers
• Controllers specs
• Views
• Add forms
• Integration specs for Views and fixing n+1 problems
• Add Devise
• Add authorization rules
• Add API endpoints.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

📝 License

This project is MIT licensed.