Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rmkubik/shoes
Shoe themed, Pokemon inspired project for Summer Slow Jams 2018 - themed Parody & Bootleg
https://github.com/rmkubik/shoes
Last synced: 13 days ago
JSON representation
Shoe themed, Pokemon inspired project for Summer Slow Jams 2018 - themed Parody & Bootleg
- Host: GitHub
- URL: https://github.com/rmkubik/shoes
- Owner: rmkubik
- License: mit
- Created: 2018-08-21T05:26:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-29T05:19:26.000Z (almost 6 years ago)
- Last Synced: 2024-08-01T19:38:04.105Z (3 months ago)
- Language: JavaScript
- Size: 755 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hyperapp One
[](https://travis-ci.org/selfup/hyperapp-one) [](https://hyperappjs.herokuapp.com "Join us")
Hyperapp One is a Webpack boilerplate for quickstarting a web application with [Hyperapp](https://github.com/hyperapp/hyperapp), JSX, and Airbnb's JavaScript [Styleguide](https://github.com/airbnb/javascript) via ESLint.
Redux Dev Tools support is included as well :smile:
Table of Contents
* [Installing](#installing)
* [Testing](#testing)
* [Development](#development)
* [Wiping the Commit History](#wiping-the-commit-history)
* [Deploying to GitHub Pages](#deploying-to-github-pages)
* [First Time](#first-time)
* [Every Time After](#every-time-after)
* [Stylistic Differences](#stylistic-differences)
* [Less Strict Alternative](#less-strict-alternative)
* [License](#license)
## Installing
```bash
git clone https://github.com/selfup/hyperapp-one
cd hyperapp-one
npm install
npm start
```
## Testing
```bash
npm test
```
All tests are in the root `test` directory. :tada:
## Development
Access [localhost:8080/webpack-dev-server](http://localhost:8080/webpack-dev-server/index.html).
The browser will reload as you save new code. 🚀
Now go code something awesome!
### Wiping the Commit History
Make sure you are in the boilerplate root and run:
```bash
npm run wipe
```
Add your remote:
```bash
git remote add origin
```
Then work as usual.
Or if you prefer to do it yourself from scratch:
```bash
rm -rf .git
git init
git add .
git commit -m "initial commit"
```
Then add your remote and work from there as usual.
```bash
git remote add origin
```
### Deploying to GitHub Pages
This will be interactive as it merges `master` into the `gh-pages` branch :pray:
```bash
npm run deploy
```
Sometimes it will say there is nothing to commit even though you have more commits.
Just do a `git push` or a `git push -f` and then check back out to master :pray:
**Now visit**:
* No custom domain: `yourUserName.github.io/yourRepoName`
* With a custom domain: `yourCustomDomain/yourRepoName`
## Stylistic Differences
As you may have noticed I don't use [prettier](https://github.com/prettier/prettier) or [Standard](https://github.com/standard/standard). I prefer [ESLint](https://github.com/eslint/eslint) and [AirBnb](https://github.com/airbnb/javascript).
**Feel free to change this.** You can easily remove `.eslintrc.js` and code without a linter, as well as remove all `eslint` packages in the `package.json`!
I just like how strict AirBnb is, and how it forces you to learn certain ways of doing things manually. It also enforces rules that make it so git diffs are less of a pain to go through. VSCode and Atom have options to have ESLint auto correct (as much as it can) the formatting via the ESLint plugin.
I also use JSX instead of the built-in `h` function, because to me it is easier to go through Code Reviews with, and is _stylistically_ more pleasing to me. It also helps with UX teams as they know HTML, and JSX is closer to HTML than pure `h` calls. See [@hyperapp/html](https://github.com/hyperapp/html) for another alternative to JSX.
## Less Strict Alternative
If you are not a fan of Webpack configuration or AirBnb ESLint, I made a similar boilerplate based off of Parcel and JSX but without a linter: [Hyperapp One Parcel](https://github.com/selfup/hyperapp-one-parcel)
## License
Hyperapp One is MIT licensed. See [LICENSE](LICENSE).