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

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


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

Last synced: 11 months ago
JSON representation

Awesome Lists containing this project

README

          


logo


Blog app

# 📗 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](#faq)
- [📝 License](#license)

# 📖 [Blog app]

**[Blog app]** is a project to learn how to start to use ruby on rails following best practices

## 🛠 Built With

### Tech Stack

Backend

### Key Features

- **[Ruby]**
- **[Postgresql]**
- **[Rspec]**

(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 PostgreSQL
- Instal PGadmin (optional)

### Setup

Clone this repository to your desired folder:

```sh
$ git clone https://github.com/anderCM/blog-app.git
$ cd blog-app
$ bundle install
```

### Usage

To run the project locally, execute the following commands to :

```sh
$ rake db:create
$ rake db:migrate
$ rake db:seed
$ rails server
```

To use the mailcatcher (allows you to sign up in development environment):

In your terminal, run the following commands:

```sh
$ gem install mailcatcher
$ mailcatcher
```

The mailcatcher is now set up and running, now simply go to `http://localhost:1080/` in your browser and you'll be able to see any outgoing emails from the application.

(back to top)

## 👥 Authors

👤 **Anderson Canales Medina**

- GitHub: [@githubhandle](https://github.com/anderCM)
- LinkedIn: [LinkedIn](https://www.linkedin.com/in/andersoncanales/)

(back to top)

## 🔭 Future Features

- [ ] **[Database Implementation]**
- [ ] **[Validations]**
- [ ] **[Tests]**

(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
Staring this project ⭐

(back to top)

## 🙏 Acknowledgments

I would like to thank to my team

(back to top)

## 📝 License

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

(back to top)