Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/microformats/microformats-parser-website-ruby

Website for Microformats Ruby parser
https://github.com/microformats/microformats-parser-website-ruby

microformats microformats2 parser rails ruby website

Last synced: about 1 month ago
JSON representation

Website for Microformats Ruby parser

Awesome Lists containing this project

README

        

# Microformats Ruby Parser Website

Website for Microformats Ruby parser (based on pin13.net by [@aaronpk](https://github.com/aaronpk)).

https://ruby.microformats.io

## Deployment

All commits to the `master` branch get auto-deployed to the live website (running on [Heroku](https://ruby.microformats.io))

## Development Status

Implemented:

- Parse a website from a pasted URL
- Parse a blob of `HTML` with optional `Base URL`
- Optionally, save `HTML` blob, creating a permalink (a la Gist)
- Optionally, display rendered `HTML` blob on the page

## Requirements

- Rails
- Postgresql

## Installation

Clone the repo:

```
git clone https://github.com/indieweb/microformats-ruby-parser-website.git
cd microformats-ruby-parser-website
```

Install the dependencies:

```
brew install postgresql
bundle
```

Set up database:

```
rake db:create
rake db:migrate
```

Start the server:

```
rails server
```

Open the site in your browser:

```
open http://localhost:3000
```

## Authors

- Shane Becker / [@veganstraightedge](https://github.com/veganstraightedge)

## Contributions

1. Fork it
2. Get it running (see Installation above)
3. Create your feature branch (`git checkout -b my-new-feature`)
4. Write your code and **specs**
5. Commit your changes (`git commit -am 'Add some feature'`)
6. Push to the branch (`git push origin my-new-feature`)
7. Create new Pull Request

If you find bugs, have feature requests or questions, please
[file an issue](https://github.com/indieweb/microformats-parser-website-ruby/issues).

## License

Microformats Ruby Parser Website is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal.

http://creativecommons.org/publicdomain/zero/1.0