sloth-app

[]() []()

Based on the original sloth cli.

sloth-app is an app to install everything you need in your new mac, with no effort =)

• Download && install
• Running Locally
• DevTools
• Packaging
• Contributing
• Helpers/Tools
• Maintainers

Download && install

1. Go to the releases page.
2. Select the latest version.
3. Download the .dmg file.
4. Install it in your mac.
5. Run Sloth and enjoy :smiley_cat:

Running locally

Clone the repository

git clone --depth=1 git@github.com:sloth-tools/sloth-app.git

Install dependencies

cd sloth-app
npm install

Development

npm start

Run end2end tests

npm run test:features

DevTools

Toggle DevTools:

• OSX: Cmd Alt I or F12

Packaging

Modify electron-builder.yml to edit package info.

For a full list of options see: https://github.com/electron-userland/electron-builder/wiki/Options.

Create a package

npm run pack

Contributing

The project uses standard-version to update the CHANGELOG with each commit message and upgrade the package version. For that reason every contribution should have a title and body that follows the conventional-changelog-standard conventions.

So this is a step by step guide to contributing to the project (mostly extracted from the standard-version docs):

1. when you land commits on your master branch, select the Rebase and Merge option.
2. add a title and body that follows the conventional-changelog-standard conventions.
3. when you're ready to release a new version:
   1. git checkout master; git pull origin master
   2. run npm run bump
   3. run npm run pack

Helpers/Tools

• Changelog
• Code of conduct
• Code style
• commitizen: A cli that will prompt the author to fill out any required commit fields at commit time. For this project we would use the cz-conventional-changelog adapter.
• conventional-changelog-standard
• cz-conventional-changelog
• standard-version

Maintainers

• @uesteibar
• @marciobarrios