66b1e06cb2
|
||
|---|---|---|
| meteor | ||
| resources | ||
| script | ||
| .gitignore | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| index.js | ||
| kitematic.icns | ||
| package.json | ||
README.md
Kitematic
Note: If you get a blank screen when running the installer, please try refreshing the app ( cmd+r ).
Kitematic is still in Beta. Any effort in helping us find issues and improving the experience is greatly appreciated!
Table of Contents
- Development
- Bugs and Feature Requests
- Documentation
- Contributing
- Community
- Versioning
- Creators
- Copyright and License
Development
- Install any version of Node.js
- Install meteor.js
curl https://install.meteor.com/ | sh. - Install meteorite
npm install meteorite -g - Install demeteorizer
npm install demeteorizer -g - Run ./script/setup.sh to download the binary requirements (things like virtualbox).
Running the development Server
- ./script/run.sh
Building the Mac OS X Package
- ./script/bundle.sh # Generates the app bundle under ./bundle
- ./script/dist.sh # Generates the app under ./dist./osx/Kitematic.app
Uninstalling
(This will improve over time.)
- Remove VirtualBox
- sudo route delete -net 172.17.0.0 -netmask 255.255.0.0 -gateway 192.168.60.103 (disable routing to containers through VM)
- rm -rf ~/Library/Application\ Support/Kitematic (remove app data)
- rm /Library/LaunchAgents/com.kitematic.route.plist (remove launch job that sets up routing to the containers)
Bugs and Feature Requests
Have a bug or a feature request? Please first read the Issue Guidelines and search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
Documentation
Kitematic's documentation and other information can be found at http://kitematic.com/docs.
Contributing
Please read through our Contributing Guidelines. Included are directions for opening issues, coding standards, and notes on development.
Development Roadmap can be found on our Trello board.
Community
Keep track of development and community news.
- Follow @kitematic on Twitter.
- Check out Kitematic's Roadmap on our Trello board.
- Read and subscribe to The Official Kitematic Blog.
- Chat with developers using Kitematic in our HipChat room.
Versioning
For transparency into our release cycle and in striving to maintain backward compatibility, Kitematic is maintained under the Semantic Versioning Guidelines. We'll try very hard to adhere to those rules whenever possible.
Creators
Team E-mail: contact@kitematic.com
Sean Li
Jeffrey Morgan
Michael Chiang
Copyright and License
Code released under the AGPL license.