Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

The Blog app is a classic example of a blog website. I am creating a fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.
https://github.com/shahadat3669/blog-app

blog microverse rails rails-application rails-authentication rails-crud ruby-on-rails ruby-on-rails-7 ruby-on-rails-project tdd-rails

Last synced: 2 days ago
JSON representation

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

Awesome Lists containing this project

README 

        





  logo

  
Blog App





# 📗 Table of Contents



- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🔭 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)



# 🎯 Blog App



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



Class diagram for catalog of my things



## 🛠 Built With 



### Tech Stack 



  Technology

  
    

        
  • Ruby
    • 

        
  • Rails
    • 

        
  • PostgresSQL
    • 

      



  Tools

  
    

        
  • VS Code
    • 

        
  • GIT
    • 

        
  • GITHUB
    • 

      



### Key Features 



This project is a simple Blog app. The main features are:



- **_User authentication and registration:_** Users can sign up for an account, log in, and log out.

- **_Post creation:_** Author can create new posts with a title and text content.

- **_Post management:_** Author can view, edit, and delete their own posts.

- **_Commenting and Liking:_** Users can add comments and likes to posts.



(back to top)



## 🚀 Live Demo 



Sorr, Currently no active link available.



(back to top)



## 💻 Getting Started 



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



### Prerequisites



you have to those tools in your local machine.



- [ ] Ruby (3.2.0)

- [ ] Rails (7.0.4)

- [ ] PostgresSQL

- [ ] GIT & GITHUB

- [ ] Any Code Editor (VS Code, Brackets, etc)



### Clone Repo



Clone the project using the following bash command in an appropriate location.



```bash

  git clone [email protected]:shahadat3669/blog-app.git

```



Go to the project directory.



```bash

  cd blog-app

```



### Create database.yml file



Copy the sample database.yml file and edit the database configuration as required.



```bash

  cp config/database.yml.sample config/database.yml

```



### Encrypted Credentials



For encrypted user name and password for the SMTP server and databases you need master key. Contact author for it. Here is a [documentation link](https://medium.com/craft-academy/encrypted-credentials-in-ruby-on-rails-9db1f36d8570) for encrypted credentials.



```bash

credentials.yml file example

# aws:

#   access_key_id: 123

#   secret_access_key: 345



# Used as the base secret for all MessageVerifiers in Rails, including the one protecting cookies.

secret_key_base: secret_key_base

postgres:

  username: username

  password: password



smtp:

  user: user

  password: password



```



### Run the server



In the project directory, you can run the project by using following bash command:



```bash

  rails server

```



And now you can visit the site with the URL http://localhost:3000



### Testing files



For testing you can run:



```bash

  rspec ./space

```



(back to top)



## 👥 Authors 



### First Author:



**Shahadat Hossain**



[![portfolio](https://img.shields.io/badge/my_portfolio-000?style=for-the-badge&logo=ko-fi&logoColor=white)](https://github.com/shahadat3669) [![linkedin](https://img.shields.io/badge/shahadat_cseng-0A66C2?style=for-the-badge&logo=linkedin&logoColor=white)](https://linkedin.com/in/shahadat-cseng) [![twitter](https://img.shields.io/badge/@shahadat3669-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/shahadat3669)



(back to top)



## 🔭 Future Features 



- [ ] **Live demo will added soon**



(back to top)



## 🤝 Contributing 



Contributions, issues, and feature requests are welcome!



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



(back to top)



## 👋 Show your support 



Give a ⭐️ if you like this project!



(back to top)



## 🔭Acknowledgments 



- My Family.

- [Microverse Team](https://www.microverse.org/).



(back to top)



## ❓ FAQ 



- **Can I use this project for personal use?**



  - Yes, you can use it.



(back to top)



## 📝 License 



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



(back to top)