Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ghostesso/blog_app


https://github.com/ghostesso/blog_app

Last synced: 18 days ago
JSON representation

Awesome Lists containing this project

README

        

Blog_App Project README Template

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 \[Blog_App\] ](#-Blog_App-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Run test](#run-test)
- [👥 Authors ](#-authors-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 [Blog_App]

**[Blog_App]** is a web app which create posts and accept likes & Comments.

## 🛠 Built With

### Tech Stack

Ruby
ROR

### Key Features

- **[DB created]**
- **[Model created]**

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

- GitHub account;
- Git installed on your OS;
- VSCode (or another code editor);
- modern browser (supporting HTML5 and CSS3) is highly recommended;
- [Ruby](https://www.ruby-lang.org/en/documentation/installation/) installed;
- [Node.js and npm](https://nodejs.org/) installed.

### Setup
* git clone [email protected]:GhostEsso/Blog_App.git
* cd BlogApp
* git checkout data_model

Setup database:
> sudo -u postgres createuser --interactive --pwprompt
(provide the username and password described in [config/database.yml](./config/database.yml))

### Install

Install the dependencies:
> gem install
> npm install

Create database:
> bin/rails db:create

(OPTIONAL) Fill the database with sample records:
> bin/rails db:seed

### Usage

To run the server:
> rails server

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

### Run test

To run tests, run the following command:
> rspec

You can also check linter errors by running these commands:
> rubocop

For testing the confirmation emails:
> gem install mailcatcher

Open [http://localhost:1080](http://localhost:1080) to view it in your browser.

(back to top)

## 👥 Authors

👤 **Essohanam TAMBANA**

- GitHub: [@GhostEsso](https://github.com/GhostEsso)
- Twitter: [@TambanaEssohana](https://twitter.com/TambanaEssohana)
- LinkedIn: [Tambana Essohanam](https://www.linkedin.com/in/essohanam-tambana/)

👤 **Christopher Uduekwe**

- GitHub: [@chudisoft](https://github.com/chudisoft)
- Twitter: [@chudisoft](https://twitter.com/christopher-uduwkwe)
- LinkedIn: [chudisoft](https://www.linkedin.com/in/chudisoft/)

## 🔭 Future Features

- [ ] **improve UI**
- [ ] **allow more interactions**

(back to top)

## 🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

## ⭐️ Show your support

If you like my Ruby Capstone Project project kindly comment or Follow me on LinkedIn, Twitter & twitter and always Your feedback will be really appreciated I have created issue if you want to share.
Thanks.

(back to top)

## 🙏 Acknowledgments

I would like to thank you All Microverse community.

(back to top)

## 📝 License

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

(back to top)