📗 Table of Contents

• 🈸 App Mock
• 📖 About the Project
  • 🧪 Linters
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Authors
• 👁️ Presentation for Project
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

🈸 App mock

📖 Blog

Blog is Ruby on Rails based project The Blog app will be a classic example of a blog website fully functional website that will show the list of posts and empower readers to interact with them by adding comments and liking posts.

Blog is where you can talk about anything you did

🧪 Linters And test

🛠 Built With

Tech Stack

In this project we utilize our skills and knowledge to create this project

Project language

• Ruby

FrameWork

• ROR

DataBase

• Postgres

Key Features

• Create A blog
• Account Feature
• Dashboard
• Database
• Authentication And Authorization
• like
• Comment
• log in
• Sign in
• Api Integration

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

• Ruby installed in your machine
• Ruby on Rails installed in your machine
• Postgres installed and all password and user being setup
• Any integrated terminal like
  • CMD
  • Bash
  • PowerShell
  • etc

Setup

Clone this repository to your desired folder:

for cloning follow this steps

• go to green code button very top left corner of this Repository container
• copy your SSH or https file and clone it in your desired folder
• or just download ZIP file
• Change UserName and Password with yours in database.yml file

OR

• Delete the credentials.yml.enc
• run EDITOR="<your editor name for example code is for VS code> --wait" bin/rails credentials:edit" and add following line in the file and close it. message pop up file save

user:
  username: "your user name"
  password: "your Password"

Install

Install this project with:

for now you don't need any installation to run project if you already followed Prerequisites

and

bundle install
npm install

Usage

To run the project, execute the following command:

you can use it for you library purpose run following commands in you terminal in root dir and if you open http://localhost:3000/ you can see App running

rails s # for running app server on port 3000
rails c # for rails console

Run tests

To run tests, run the following command:

rspec spec 

And for Linters

rubocop . //=> for ruby file linting 
npx stylelint "**/*.{css,scss}" //=> for CSS or SASS file linting 

-A and --fix for auto fixing respectively

(back to top)

👥 Authors

👤 Adarsh Pathak

• GitHub: @PowerLevel9000
• Twitter: @PowerLevel9002
• LinkedIn: Adarsh pathak
• Portfolio: Adarsh Pathak

👤 Damilare Adepoju

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn
• GitUp Page: My Page

(back to top)

👁️ Presentation for Project

presentation-video

(back to top)

🔭 Future Features

• Styling of various webpage
• Improved Dashboard
• Notification Feature
• Animation
• Dislike and Edit comments

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

or

If you like this project please give it star

(back to top)

🙏 Acknowledgments

I would like to thank microverse to give this opportunity to show up my skills

and the Ruby on rails docs

(back to top)

📝 License

This project is GPL-3.0 licensed.

(back to top)