Microverse 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

📖 [Chronicles]

Describe your project in 1 or 2 sentences.

[Chronicles] is a blog app where users can make accounts, create posts, get liked or commented upon by others.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• Embedded Ruby

Server

• Rails

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• Post, Comment, Like and Delete
• Authentication with Devise
• Authorization with Cancan

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Coming Soon

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

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:

Example commands:

  git clone git@github.com:OmarMWarraich/chronicles.git

Install

Install this project with:

Example command:

  gem install

Do not forget to update the Ruby version in the GemFile and .ruby-version files of the Project if having conflict with your local version.

Usage

To run the project, execute the following command:

Example command:

  rails server

Database Configuration

Update the username and password in config/database.yml as per your local configurations. Then run the following commands.

  rails db:create
  rails db:schema:load

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

👤 OmarMWarraich

• GitHub: @OmarMWarraich
• Twitter: @omarwarraich1
• LinkedIn: LinkedIn

(back to top)

🔭 Future Features

• Api Endpoints
• Upload Pics with Carrierwave
• NavBar having UserLogo w/ Gravtastic

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank Team Microverse for giving me the oppurtunity to work in a professional remote software development programme.

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• [Does this app have a friendly UI?]

  • [Yes, this app has a very friendly UI.]

• [Does this app have a database]

  • [This app uses PostgreSQL database. For runnng this app, PostgreSQL need to be installed on your system.]

(back to top)

📝 License

This project is MIT licensed.

(back to top)