Blog App

Blog App is a classic example of a blog website. It is a fully functional website that shows the list of posts and empowers readers to interact with them by adding comments and liking posts.

📗 Table of Contents

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

📖 Blog App

Blog App is a classic example of a blog website. It is a fully functional website that shows the list of posts and empowers readers to interact with them by adding comments and liking posts..

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• React.js

Server

• Ruby

Database

• PostgreSQL

Key Features

• authentication and authorization
• write posts
• like posts
• leave comments

(back to top)

🚀 Live Demo

• The Live Demo will be added after completing next projects for this app.

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

• GitHub account;
• Git installed on your OS;
• VSCode (or another code editor);
• modern browser (supporting HTML5 and CSS3) is highly recommended;
• Ruby installed;
• Node.js and npm installed.

Setup

Clone this repository to your desired folder:

Login to your GitHub account. Clone this repository to your desired folder:

cd my-folder git clone [email protected]:Zilola-Nazarova/blog-app.git

Setup database:

sudo -u postgres createuser --interactive --pwprompt (provide the username and password described in config/database.yml)

Install

Install the dependencies:

gem install npm install

Create database:

bin/rails db:create

(OPTIONAL) Fill the database with sample records:

bin/rails db:seed

Usage

To run the server:

rails server

Open http://localhost:3000 to view it in your browser.

Run tests

To run tests, run the following command:

rspec

You can also check linter errors by running these commands:

rubocop

For testing the confirmation emails:

gem install mailcatcher

Open http://localhost:1080 to view it in your browser.

(back to top)

👥 Authors

👤 Zilola Nazarova

• GitHub: @Zilola-Nazarova
• Twitter: @NazarovaZi
• LinkedIn: in/NazarovaZi

👤 Fatima Najafi

• GitHub: @fatima-najafi
• LinkedIn: in/fatima-najafi

(back to top)

🔭 Future Features

• improve UI
• allow more interactions

(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 just star it!

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse program for the knowledge and skills I have acquired in Modules 1-4.

I am grateful to all previous project reviewers for their advice. Thanks to them I could build this app.

(back to top)

❓ FAQ (OPTIONAL)

• Why is there no Live Demo link?

  • This is a student project and the Live Demo will be added after reaching the corresponding phase of the project.

(back to top)

📝 License

This project is MIT licensed.

(back to top)