Inkling-Blog-App - GitLite

KO | EN

gitlite — search

#javascript #python #android #machine-learning #linux #nodejs #macos #java #cli #kubernetes #awesome-list #ios #openai #open-source

Inkling-Blog-App

(★ 9)

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 Ruby, Ruby on Rails and PosgreSQL

Inkling-Blog-App Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Inkling Blog ](#-inkling-blog-)
  - [🛠 Built With ](#-built-with-)
    - [Tech Stack ](#tech-stack-)
    - [Key Features ](#key-features-)
  - [💻 Getting Started ](#-getting-started-)
    - [Prerequisites](#prerequisites)
    - [Setup](#setup)
    - [Install](#install)
    - [Usage](#usage)
  - [👥 Authors ](#-authors-)
  - [🔭 Future Features ](#-future-features-)
  - [🤝 Contributing ](#-contributing-)
  - [⭐️ Show your support ](#️-show-your-support-)
  - [📝 License ](#-license-)

# 📖 Inkling Blog <a name="about-project"></a>

> 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 <a name="built-with"></a>

### Tech Stack <a name="tech-stack"></a>

> Here are the tech stacks applied in this project.
<details>
  <summary>Language</summary>
  <ul>
    <li><a href="https://www.ruby-lang.org/en/">Ruby</a></li>
    <li><a href="https://www.javascript.com/">JavaScript</a></li>
  </ul>
</details>

<details>
  <summary>Framework</summary>
  <ul>
    <li><a href="https://rubyonrails.org/">Ruby on Rails</a></li>
  </ul>
</details>

<details>
<summary>Database</summary>
  <ul>
    <li><a href="https://www.postgresql.org/">PostgreSQL</a></li>
  </ul>
</details>

<details>
  <summary>Linters</summary>
  <ul>
    <li><a href="https://rubocop.org/">Rubocop</a></li>
    <li><a href="https://stylelint.io/">Stylelint</a></li>
  </ul>
</details>

<details>
  <summary>Markup Languages</summary>
  <ul>
    <li><a href="https://html.spec.whatwg.org/multipage/">HTML5</a></li>
    <li><a href="https://www.w3.org/TR/CSS/#css">CSS3</a></li>
  </ul>
</details>

<details>
  <summary>Test Library</summary>
  <ul>
    <li><a href="https://rspec.info/">RSpec</a></li>
  </ul>
</details>

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Key Features <a name="key-features"></a>
> 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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 💻 Getting Started <a name="getting-started"></a>

### Prerequisites

In order to run this project you need:

- Install Ruby on your computer (machine)

### Setup
Clone this repository to your desired folder:
```sh
  git clone git@github.com:PraisesPJMT/Inkling-Blog-App.git
  cd Inkling-Blog-App
```
### Install
Install this project with:
```sh
  gem install bundler
  bundle install
```
### Usage
To run the project, execute the following command:
```sh
  rails server
```
- After running `rails server`, use the app on [http://localhost:3000/](http://localhost:3000/) in the browser!
- For more information please visit [Ruby-on-Rails](https://rubyonrails.org/).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 👥 Authors <a name="authors"></a>
👤 **Praises Tula**

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/PraisesPJMT/)
[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/praises-tula/)
[![Twitter](https://img.shields.io/badge/Twitter-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/PraisesPJMT/)

[![Gmail](https://img.shields.io/badge/Gmail-D14836?style=for-the-badge&logo=gmail&logoColor=white)](mailto:praisesmusa@gmail.com)
[![AngelList](https://img.shields.io/badge/AngelList-%23D4D4D4.svg?style=for-the-badge&logo=AngelList&logoColor=black)](https://angel.co/u/praises-tula/)

👤 **Moathal Kachi**

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/Moathal)
[![LinkedIn](https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/moathalkachi)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 🔭 Future Features <a name="future-features"></a>

> These are features that will be add to the project.
- [X] **Creating a data model**
- [X] **Processing data in models**
- [X] **Validations and Model specs**
- [X] **Setup and controllers**
- [X] **Controllers specs**
- [X] **Views**
- [X] **Add forms**
- [X] **Integration specs for Views and fixing `n+1` problems**
- [X] **Add Devise**
- [X] **Add authorization rules**
- [X] **Add API endpoints.**

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 🤝 Contributing <a name="contributing"></a>

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## ⭐️ Show your support <a name="support"></a>

Give a ⭐️ if you like this project!
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 📝 License <a name="license"></a>

This project is [MIT](./LICENSE) licensed.