https://github.com/harvestprofit/sample-blog

📑 Example API-only blog
https://github.com/harvestprofit/sample-blog

Last synced: about 1 month ago
JSON representation

📑 Example API-only blog

• Host: GitHub
• URL: https://github.com/harvestprofit/sample-blog
• Owner: HarvestProfit
• License: mit
• Created: 2021-04-05T19:46:22.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T21:49:13.000Z (5 months ago)
• Last Synced: 2024-08-01T01:46:05.133Z (5 months ago)
• Language: Ruby
• Homepage: https://hp-sample-blog-0719668c26b6.herokuapp.com/
• Size: 74.2 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Sample Blog

![CI](https://github.com/HarvestProfit/sample-blog/workflows/CI%20Suite/badge.svg) [![codecov](https://codecov.io/gh/HarvestProfit/sample-blog/branch/main/graph/badge.svg?token=KSj36vyBgV)](https://codecov.io/gh/HarvestProfit/sample-blog)

Incredibly simple api-only blog!

This blog is super simple - it allows you to submit blog posts to the server, and can render them in an API.

## Consuming the API

We have some simple documentation on how to [consume this API](https://documenter.getpostman.com/view/2582145/TzCQbn5S).

## Development

This project was scaffolded with rails.

### Prerequisites

Please install the following:

- [Ruby](https://www.ruby-lang.org/en/downloads/)

  - Feel free to use [RVM](https://rvm.io/) or [Rbenv (recommended)](https://github.com/rbenv/rbenv) for version management

- [Postgres.app](https://postgresapp.com/)

In order to run the project in development, you'll need to install the

required RubyGems and set up your Postgres database:

```bash

bundle install

rails db:setup

```

Then you can start your local server with `rails server` (or `rails s` for short).

## License

This project is [MIT Licensed](./LICENSE.md).

## Deploy to Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)