Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codehass/blog-app

The Blog app exemplifies a typical blog website. Its functionality includes displaying a list of posts and enabling readers to engage with them by leaving comments and likes.
https://github.com/codehass/blog-app

postgresql rails rspec ruby

Last synced: 21 days ago
JSON representation

The Blog app exemplifies a typical blog website. Its functionality includes displaying a list of posts and enabling readers to engage with them by leaving comments and likes.

Awesome Lists containing this project

README

        

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 blog-app ](#-practice-test-driven-developmenttdd-)
- [🛠 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-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [❓ FAQ ](#-faq-)
- [📝 License ](#-license-)

# 📖 blog-app

The Blog app exemplifies a typical blog website. Its functionality includes displaying a list of posts and enabling readers to engage with them by leaving comments and likes.

## 🛠 Built With

## 🛠 Tech Stack

  • Ruby

  • Rail

  • Postgresql
  • Client

    ### Key Features

    > - Add post.
    > - Comment the post.
    > - Like the post.

    (back to top)

    ## 💻 Getting Started

    ## UML Diagram :

    To get a local copy up and running, follow these steps.

    ### Prerequisites

    In order to run this project you need:

    - Mac or PC
    - Install Ruby
    - Understanding of Ruby
    - **IRB**
    - **Gems to test linters**
    - **RSpec to run tests**

    ### Setup

    - Clone this repository to your desired folder:

    ```sh
    git clone https://github.com/codehass/blog-app.git
    ```

    - Navigate into the cloned folder

    ```sh
    cd blog-app

    ```

    - Install this project with:

    ```sh
    bundle install
    ```

    - Set up the database

    ```sh
    rails db:create db:migrate db:seed
    ```

    - Start the server

    ```sh
    rails s
    ```

    - Run tests

    ```sh
    rspec spec
    ```

    (back to top)

    ## 👥 Authors

    👤 **Hassan EL OUARDY**

    - GitHub: [@codehass](https://github.com/codehass)
    - Twitter: [@hassanelourdy](https://twitter.com/hassanelourdy)
    - LinkedIn: [Hassan El OUARDY](https://www.linkedin.com/in/hassan-el-ouardy-360b99169/)

    👤 **Wahaj Ali**

    - GitHub: [@Wahaj-Ali](https://github.com/Wahaj-Ali)
    - LinkedIn: [@wahaj-ali96](https://www.linkedin.com/in/wahaj-ali96/)

    ## 🔭 Future Features

    - [ ] Add post
    - [ ] likes
    - [ ] comments

    (back to top)

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

    Feel free to check the [issues page](https://github.com/codehass/blog-app/issues).

    (back to top)

    ## ⭐️ Show your support

    If you like this project, please leave a ⭐️

    (back to top)

    ## 🙏 Acknowledgments

    I would like to thank Microverse for providing us with reading materials that aided us to during the project development

    (back to top)

    ## 📝 License

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

    (back to top)