Skip to content

Commit b5d8ce3

Browse files
committed
Add README to project.
1 parent e713ddc commit b5d8ce3

1 file changed

Lines changed: 61 additions & 0 deletions

File tree

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Microformats JavaScript/Node Parser Website
2+
3+
Website for Microformats JavaScript parser (based on pin13.net by [@aaronpk](https://github.com/aaronpk)).
4+
5+
https://node.microformats.io
6+
7+
## Deployment
8+
9+
All commits to the `main` branch get auto-deployed to the live website (running on [Heroku](https://node.microformats.io))
10+
11+
## Getting Started
12+
13+
This website is built using [Yarn](https://yarnpkg.com/).
14+
15+
To start working with this project, first clone the repository for this project:
16+
17+
```
18+
git clone https://github.com/microformats/microformats-parser-website-node.git
19+
cd microformats-parser-website-node
20+
```
21+
22+
Next, install the required dependencies and start the server:
23+
24+
```
25+
yarn install
26+
yarn run start
27+
# Or, if you'd like a different port:
28+
# PORT=5000 yarn run start
29+
```
30+
31+
You can view your running local application at this URL:
32+
33+
```
34+
http://localhost:9080
35+
```
36+
37+
## Requirements
38+
39+
- [Node 17](https://nodejs.org/en/blog/release/v17.0.0/)
40+
- [Yarn](https://yarnpkg.com/cli/install)
41+
42+
## Contributions
43+
44+
1. Fork it
45+
2. Get it running (see Installation above)
46+
3. Create your feature branch (`git checkout -b my-new-feature`)
47+
4. Commit your changes (`git commit -am 'Add some feature'`)
48+
5. Push to the branch (`git push origin my-new-feature`)
49+
6. Create new Pull Request
50+
51+
If you find bugs, have feature requests or questions, please
52+
[file an issue](https://github.com/microformats/microformats-parser-website-node/issues).
53+
54+
## License
55+
56+
Microformats Parser Website Rust is dedicated to the public domain using Creative Commons -- CC0 1.0 Universal.
57+
58+
http://creativecommons.org/publicdomain/zero/1.0
59+
60+
## Contributors
61+
- [Jacky Alciné](https://github.com/jalcine) — https://jacky.wtf/about

0 commit comments

Comments
 (0)