Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kaylemba/blog-app


https://github.com/kaylemba/blog-app

Last synced: 10 days ago
JSON representation

Awesome Lists containing this project

README

        



logo

Microverse README Template

# 📗 Table of Contents

- [📖 About the Project](#about-project)
- [🛠 Built With](#built-with)
- [Tech Stack](#tech-stack)
- [Key Features](#key-features)
- [🚀 Live Demo](#live-demo)
- [💻 Getting Started](#getting-started)
- [Setup](#setup)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Usage](#usage)
- [Run tests](#run-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [👥 Authors](#authors)
- [🔭 Future Features](#future-features)
- [🤝 Contributing](#contributing)
- [⭐️ Show your support](#support)
- [🙏 Acknowledgements](#acknowledgements)
- [❓ FAQ (OPTIONAL)](#faq)
- [📝 License](#license)

# 📖 [Blog App]

> Describe your project in 1 or 2 sentences.

**[Blog Website]** is a simple blog app built using the Ruby on Rails framework.

## 🛠 Built With

### Tech Stack

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

Client

Server

Database

### Key Features

> Describe between 1-3 key features of the application.

- [ ] **[Add comment]**
- [ ] **[Add likes]**
- [ ] **[Delete comment]**
- [ ] **[Remove like]**

## Project requirements

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/sneak_peek.md)

### Phase 1 - setup and controllers

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/Setup_Controllers_project.md)

### Phase 2 - controllers specs

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/controller_specs_project.md)

### Phase 3 - creating data model

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/creating_data_model_project.md)

### Phase 4 - processing data in models

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/Processing_data_model_project.md)

### Phase 5 - views

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/Views_project.md)

### Phase 6 - add forms

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/forms_project.md)

### Phase 7 - validations, model specs, and n+1 problems

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/blog_app_validations_model_spec_n+1.md)

### Phase 8 - add devise

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/blog_app_devise.md)

### Phase 9 - add authorization rules

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/blog_app_add_authorization.md)

### Phase 10 - integration specs for views

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/projects/Integration_specs_project.md)

### Phase 11 - add API endpoints

The project requirements can be viewed [here](https://github.com/microverseinc/curriculum-rails/blob/main/blog-app/blog_app_api_endpoints.md)

(back to top)

## 🚀 Live Demo

> Add a link to your deployed project.

- [Live Demo Link](https://yourdeployedapplicationlink.com)

(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
- [Ruby](https://www.ruby-lang.org/en/)
- [Rails](https://gorails.com/)

In order to run this project you need:

### Install

Install this project with:

### Usage

To run the project, execute the following command:

### Run tests

To run tests, run the following command:

### Deployment

You can deploy this project using:

(back to top)

## 👥 Authors

> Mention all of the collaborators of this project.

👤 **Kalolo Chola Lemba**

- GitHub: [@KayLemba ](https://github.com/KayLemba)
- Twitter: [@King-Kaylo1 ](https://twitter.com/King_Kaylo1)
- LinkedIn: [@kalolo-lemba](https://www.linkedin.com/in/https://www.linkedin.com/in/kalolo-lemba)

👤 **Yuriy Chamkoriysk**

- GitHub: [@Hombre2014](https://github.com/Hombre2014)
- Twitter: [@Chamkoriyski](https://twitter.com/Chamkoriyski)
- LinkedIn: [axebit](https://linkedin.com/in/axebit)

(back to top)

## 🔭 Future Features

> Describe 1 - 3 features you will add to the project.

- [ ] **[Add comment]**
- [ ] **[Add likes]**
- [ ] **[Delete comment]**
- [ ] **[Remove like]**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)

## ⭐️ Show your support

> Write a message to encourage readers to support your project

If you like this project...

(back to top)

## 🙏 Acknowledgments

> Give credit to everyone who inspired your codebase.

I would like to thank...

- Microverse

(back to top)

## ❓ FAQ (OPTIONAL)

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

- **[Question_1]**

- [Answer_1]

- **[Question_2]**

- [Answer_2]

(back to top)

## 📝 License

This project is [MIT](./LICENSE) licensed.

_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._

(back to top)