Skip to content

Latest commit

 

History

History
222 lines (143 loc) · 5.53 KB

README.md

File metadata and controls

222 lines (143 loc) · 5.53 KB

logo

Blog App

📗 Table of Contents

🎯 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.

  git clone git@github.com:shahadat3669/blog-app.git

Go to the project directory.

  cd blog-app

Create database.yml file

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

  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 for encrypted credentials.

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:

  rails server

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

Testing files

For testing you can run:

  rspec ./space

(back to top)

👥 Authors

First Author:

Shahadat Hossain

portfolio linkedin twitter

(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.

(back to top)

👋 Show your support

Give a ⭐️ if you like this project!

(back to top)

🔭Acknowledgments

(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 licensed.

(back to top)