README Template

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 The Blog

This feature-rich blog, powered by Ruby on Rails, Bootstrap, and Sassc_Rails, offers an engaging user experience. User Authentication and ActionText for posts and comments, complemented by notifications, drive user engagement. A live search bar enhances usability, while an admin dashboard with visual graphs tracks views and statistics. Admins can showcase their projects through user profiles, and both posts and projects support drag-and-drop uploads. Subscription features, integrated with Stripe and Pay, enable monetization and robust content management. Technologies like Postgresql, Heroku, Devise, Noticed, Ransack, Bullet, Wicked, Ahoy_Matey, Chartkick, Acts_As_List, and Whenever ensure efficient performance and scalability. Together, these elements create a dynamic and user-friendly blogging platform.

🛠 Built With

Tech Stack

Client

• Ruby

Server

• Rails

Database

• PostgreSQL

Key Features

• Search bar
• Notifications
• Drag and Drop Uploads

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

Prerequisites

In order to run this project you need:

Example command:

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:OmarMWarraich/the_blog.git

Install

Install this project with:

  cd my-project
  bundle install

Environment Vars

  EDITOR="code --wait" bin/rails credentials:edit

Add the following to the credentials.yml file.

  stripe:
    public_key: "your_stripe_publishable_key"
    private_key: "your_stripe_private_key"
    signing_secret: "your_stripe_signing_secret"

Save the file and exit.

Usage

To run the project, execute the following command:

  rails server

Deployment

You can deploy this project following this documentation.

(back to top)

👥 Author

• GitHub: OmarMWarraich
• Twitter: @omarwarraich1
• LinkedIn: o-va

(back to top)

🔭 Future Features

• Chat
• Transactional Emails
• Following

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project please give it a star.

(back to top)

🙏 Acknowledgments

I would like to thank anyone whose code was used.

(back to top)

❓ FAQ

• How can I run this project on my local machine?

  • Carefully, follow all the instructions in this README. You must have Rails7+ and Ruby3+ installed.

• How can I deploy this project?

  • The project can be easily deployed on Heroku.

(back to top)

📝 License

This project is MIT licensed.

(back to top)