Microformats JavaScript/Node Parser Website
Website for Microformats JavaScript parser (based on pin13.net by @aaronpk).
Deployment
All commits to the main
branch get auto-deployed to the live website running on Heroku.
Git workflow
The base branch is next
. All PRs should target this branch.
To initiate a release:
- Create a new branch, from
next
namedrelease/x.y.z
- Bump the version in
package.json
tox.y.z
- Merge
release/x.y.z
tomain
. This will trigger the deployment. - Merge
main
intonext
Getting Started
This website is built using Yarn.
To start working with this project, first clone the repository for this project:
git clone https://github.com/microformats/microformats-parser-website-node.git
cd microformats-parser-website-node
Next, install the required dependencies and start the server:
yarn install
yarn start
# Or, if you'd like a different port:
# PORT=5000 yarn start
You can view your running local application at this URL:
http://localhost:9000
Requirements
Contributions
- Fork it
- Get it running (see Installation above)
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
If you find bugs, have feature requests or questions, please file an issue.
License
Microformats Parser Website Node is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal.