From b5d8ce3d949345d729be2f4e14db1cf74f61061d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacky=20Alcin=C3=A9?= Date: Tue, 13 Dec 2022 10:27:19 -0500 Subject: [PATCH 1/4] Add README to project. --- README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..d44e10a --- /dev/null +++ b/README.md @@ -0,0 +1,61 @@ +# Microformats JavaScript/Node Parser Website + +Website for Microformats JavaScript parser (based on pin13.net by [@aaronpk](https://github.com/aaronpk)). + +https://node.microformats.io + +## Deployment + +All commits to the `main` branch get auto-deployed to the live website (running on [Heroku](https://node.microformats.io)) + +## Getting Started + +This website is built using [Yarn](https://yarnpkg.com/). + +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 run start +# Or, if you'd like a different port: +# PORT=5000 yarn run start +``` + +You can view your running local application at this URL: + +``` +http://localhost:9080 +``` + +## Requirements + +- [Node 17](https://nodejs.org/en/blog/release/v17.0.0/) +- [Yarn](https://yarnpkg.com/cli/install) + +## Contributions + +1. Fork it +2. Get it running (see Installation above) +3. Create your feature branch (`git checkout -b my-new-feature`) +4. Commit your changes (`git commit -am 'Add some feature'`) +5. Push to the branch (`git push origin my-new-feature`) +6. Create new Pull Request + +If you find bugs, have feature requests or questions, please +[file an issue](https://github.com/microformats/microformats-parser-website-node/issues). + +## License + +Microformats Parser Website Rust is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal. + +http://creativecommons.org/publicdomain/zero/1.0 + +## Contributors +- [Jacky Alciné](https://github.com/jalcine) — https://jacky.wtf/about From a3699390c2e361f97dec5ceee6f1093eb049564f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jacky=20Alcin=C3=A9?= Date: Tue, 13 Dec 2022 10:32:37 -0500 Subject: [PATCH 2/4] Update text referencing live app. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d44e10a..17900d7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ https://node.microformats.io ## Deployment -All commits to the `main` branch get auto-deployed to the live website (running on [Heroku](https://node.microformats.io)) +All commits to the `main` branch get auto-deployed to the live website [running on Heroku](https://node.microformats.io). ## Getting Started From df482abb51b70a52fbe2706e18766e53d4a761ad Mon Sep 17 00:00:00 2001 From: Aimee Gamble-Milner <12508200+aimee-gm@users.noreply.github.com> Date: Thu, 14 Sep 2023 20:36:30 +0100 Subject: [PATCH 3/4] Update README.md Co-authored-by: Anthony Ciccarello --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 17900d7..bc9ce9d 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,7 @@ If you find bugs, have feature requests or questions, please ## License -Microformats Parser Website Rust is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal. +Microformats Parser Website Node is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal. http://creativecommons.org/publicdomain/zero/1.0 From e605991ecab8caf75c4d465dc0dc4da8496e5f83 Mon Sep 17 00:00:00 2001 From: aimee-gm <12508200+aimee-gm@users.noreply.github.com> Date: Thu, 14 Sep 2023 20:51:44 +0100 Subject: [PATCH 4/4] Update readme & add license in package.json --- README.md | 21 ++++++++++++++------- package.json | 1 + 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index bc9ce9d..5e6c77b 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,16 @@ https://node.microformats.io All commits to the `main` branch get auto-deployed to the live website [running on Heroku](https://node.microformats.io). +### Git workflow + +The base branch is `next`. All PRs should target this branch. + +To initiate a release: +* Create a new branch, from `next` named `release/x.y.z` +* Bump the version in `package.json` to `x.y.z` +* Merge `release/x.y.z` to `main`. This will trigger the [deployment](#deployment). +* Merge `main` into `next` + ## Getting Started This website is built using [Yarn](https://yarnpkg.com/). @@ -23,15 +33,15 @@ Next, install the required dependencies and start the server: ``` yarn install -yarn run start +yarn start # Or, if you'd like a different port: -# PORT=5000 yarn run start +# PORT=5000 yarn start ``` You can view your running local application at this URL: ``` -http://localhost:9080 +http://localhost:9000 ``` ## Requirements @@ -55,7 +65,4 @@ If you find bugs, have feature requests or questions, please Microformats Parser Website Node is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal. -http://creativecommons.org/publicdomain/zero/1.0 - -## Contributors -- [Jacky Alciné](https://github.com/jalcine) — https://jacky.wtf/about +http://creativecommons.org/publicdomain/zero/1.0 \ No newline at end of file diff --git a/package.json b/package.json index 24b4ff9..296d47e 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "microformats-website-node", "description": "A website written using Node to demonstrate Microformats2 usage", "version": "1.1.0", + "license": "CC0-1.0", "engines": { "node": "17.x", "yarn": "1.x"