Alpha Blog 📑

📗 Table of Contents

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

📖 Alpha Blog 📑

Alpha Blog 📑 The Alpha Blog app is a classic example of a blog website. this is a fully functional website that will show the list of articles and empower readers to interact with them by adding comments and liking posts.

🛠 Built With

Tech Stack

Server

• Ruby

• Ruby On Rails

Key Features

• Ruby on Rails
• Creating data model
• Functional website
• Database
• Unit Testing

(back to top)

🚀 Live Demo

• Not live yet

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

• Install ruby using link
• Install ruby on rails using link

Setup

Clone this repository to your desired folder:

  mkdir folder_name
  cd folder_name
  git clone [email protected]:tsheporamantso/Alpha_Chat_v2.git

Install

Install this project with:

  bundle install

  rails db:migrate

Usage

To run the project, execute the following command: run the result on the terminal through:

  rails server

Run tests

To run tests, execute the following command on the terminal:

  rails test

Deployment

Not deployed

(back to top)

👥 Authors

👤 Gladwin Tshepo Ramantso

• GitHub: @tsheporamantso
• Twitter: @ramgt001
• LinkedIn: Tshepo Gladwin Ramantso

(back to top)

🔭 Future Features

• Validation and Model specs
• Processing data in models
• Controllers
• Controllers specs
• Views
• Forms
• Intergration specs for Views and fixing n+1 problems
• Add Devices
• Add authorizations rules
• Add API endpoints
• API documentation

(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 please give a star on github & follow us on twitter and also connect on Linkedin.

(back to top)

🙏 Acknowledgments

I would like to thank:

• Mashrur Hossain

(back to top)

📝 License

This project is MIT licensed.

(back to top)