rebaz36 / BlogApp

BlogApp

Project by Rebaz Farid

📗 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

📖 Tangled blog app

Tangled is a fully functional website that shows the list of posts and allows users to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• Sign in
• Adding posts for each user
• Liking multiple posts

(back to top)

🚀 Live Demo

• Live Demo Link

Available soon...

(back to top)

💻 Getting Started

To get a local copy up and running it in your machine, follow the next steps.

Prerequisites

In order to run this project you need:

• Internet connection.
• Basic knowledge of Git/Terminal.
• Visual Studio Code Installed.
• Ruby installed.
• Ruby on Rails installed.

Setup

Clone this repository to your desired folder:

Terminal

cd my-folder git clone https://github.com/rebaz36/BlogApp.git

Install

Install almost all dependencies/gems of the project by running:

• This one will install all gems inside GemFile including Rubocop:

Bundle install or Bundle i

• This one will install stylelinter:

npm install --save-dev stylelint@13.x stylelint-scss@3.x stylelint-config-standard@21.x stylelint-csstree-validator@1.x

Usage

To run the project, execute the following command:

rails server or rails s

To run stylinter:

npx stylelint "**/*.{css,scss}"

To run rubocop:

rubocop

Run tests

To run tests, run the following command:

bin/rails test test/models/article_test.rb

(back to top)

👥 Authors

👤 Rebaz Farid

• GitHub: @Rebaz on Github
• LinkedIn: Rebaz on LinkedIn

(back to top)

🔭 Future Features

• Register new users

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Hi, I would appreciate if you give this project a star(⭐️) this will encourage me to improve it even further.

(back to top)

🙏 Acknowledgments

"The best way to predict the future is to create it."

(back to top)

❓ FAQ

• How can I contribute to this project?

You can contribute to this project by opening an issue or a pull request.

• How can I report a bug?

You can report a bug by opening an issue.

• How can I request a feature?

You can request a feature by opening an issue.

(back to top)

📝 License

This project is MIT licensed.

(back to top)