README

Microverse Education project by Danys Linares

📗 Table of Contents

• README
• 📗 Table of Contents
• 📖 Blog app
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Terminal
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Blog app

The Art of Development Is a fully functional website that shows the list of posts and to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

Client

• Linters

Server

• Ruby
• Ruby on Rails

Database

• PostgreSQL

Key Features

• Sign in
• Adding posts for each user
• Liking multiple posts
• Add API endpoints

(back to top)

🚀 Live Demo

• Live Demo Link

Under construction...

(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 git@github.com:d4nQw3rty/the-art-of-development-blog.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

👤 Danys Linares

• GitHub: @github
• Twitter: @twitter
• LinkedIn: LinkedIn

👤 Kanza Tahreem

• GitHub: @KanzaTahreem
• Twitter: @kanza_tahreem
• LinkedIn: kanza-tahreem

👤 Camilo Vela

• GitHub: @camilovelag
• Twitter: @camilovelag
• LinkedIn: camilovelag

(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 and build the social network of the future.

(back to top)

🙏 Acknowledgments

"You only fail when you stop trying"

(back to top)

❓ FAQ

• Can I publish this project as mine?

  • No, but you can use it as an inspiration or for educational purposes.

• Can I modify it while practicing?

  • Yes, you can do it, but remember to give credit to the original author.

(back to top)

📝 License

This project is MIT licensed.

(back to top)