https://github.com/carbonfive/seed-crystal
Opinionated workstation configuration tool -- From zero to productive
https://github.com/carbonfive/seed-crystal
workstation-configuration
Last synced: about 1 year ago
JSON representation
Opinionated workstation configuration tool -- From zero to productive
- Host: GitHub
- URL: https://github.com/carbonfive/seed-crystal
- Owner: carbonfive
- License: mit
- Created: 2019-09-03T20:57:53.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-11T19:09:07.000Z (over 6 years ago)
- Last Synced: 2025-01-30T17:36:57.755Z (over 1 year ago)
- Topics: workstation-configuration
- Language: Shell
- Homepage:
- Size: 142 KB
- Stars: 3
- Watchers: 31
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://images.app.goo.gl/9GZ6uxdC1vwoSpVf7)
# Seed::Crystal
An opinionated, _tested_, workstation configuration tool -- From zero to productive
[](https://circleci.com/gh/carbonfive/seed-crystal/tree/master)
## Installation
```sh
/bin/sh -c "$(curl -fsSL https://raw.githubusercontent.com/carbonfive/seed-crystal/master/bootstrap.sh)"
```
## Opt-ins
The base install is just enough to get you productive without too much ceremony, but what if you want to do mobile work?
Or design work? Run one or more these setup scripts. The baseline set up is `bin/workstation-setup.sh`
```sh
cd ~/Documents/seed-crystal
sh bin/design-setup.sh
sh bin/eng-setup.sh
sh bin/java-setup.sh
sh bin/mobile-setup.sh
sh bin/web-setup.sh
```
## Software Updates
Seed::Crystal remembers which set up packages you've already installed, and if you re-run the `bootstrap.sh` script,
then it will re-run all of the scripts that you've used before.
```sh
$ cd ~/Documents/seed-crystal
$ git pull
$ sh bootstrap.sh
Notice: This workstation has already been seeded. Re-running setup scripts.
Notice:
1 bin/workstation-setup.sh
2 bin/web-setup.sh
3 bin/design-setup.sh
...
```
## Core Values
1. Standard toolsets make it easier for contributors to roll onto a project. What you do on your personal projects is your business, but we are in the business of delivering value to our clients. There shall be no `vim`/`emacs` wars.
2. Default configurations unless there is a really good reason not to follow it.
3. Up and running *fast*.
4. If something is important enough to include, but you can't find unanimous agreement, pick something, anything and commit. Nobody dies because of a linter configuration choice. We can always come back and make it better.
5. Document rationale if at all possible. Document in `code` if at all possible.
6. Idempotent. At least non-destructive.
## Realities
- This script is probably run once per project _at best_. Worst case, it is done on your first day at work, and not again until your hardware is repurposed for someone else.
- It's hard to test perfectly: Wipe the laptop. Reinstall the OS. Run the script.
- Our world is broken up into somewhat orthogonal core competencies: RoR, React, Mobile, Elixir, Go. No one person will be an expert on all of these toolchains. Provide low-ceremony, low friction tools to help the experts decide what's important.
## Tooling
### Core
- [Homebrew](https://brew.sh) - macOS package manager
- [Calibre](https://calibre-ebook.com) - One stop E-book manager
- [Flycut](https://github.com/TermiT/Flycut) - Clipboard manager
- [Google Drive](https://cloud.google.com/drive-enterprise)
- [KeepingYouAwake](https://github.com/newmarcel/KeepingYouAwake/) - Prevents your Mac from going to sleep.
- [Logitech Control Center](https://support.logitech.com/en_us/product/3129)
- [mas](https://github.com/mas-cli/mas) - Mac App Store command line interface
- [Muzzle](https://muzzleapp.com) - Silence notifications when screen sharing
- [Notion](https://www.notion.so/product) - Our corporate notebook of memories
- [ShiftIt](https://github.com/fikovnik/ShiftIt/) - Window manager
- [Slack](https://slack.com) - Chit chats on the internets
- [Time Out](https://www.dejal.com/timeout/) - Remind yourself to take a break
- [Yet Another Dotfiles Manager](https://yadm.io)
- [Zoom US](https://www.zoom.us/) - We default to Zoom for video conferencing
### Design
- [Adobe Create Cloud](https://creative.adobe.com/products/creative-cloud) - Download & installer for ACC
- [Sketch](https://www.sketchapp.com/) - Visual design tool
- [SkyFonts](https://skyfonts.com/) - Font manager for the cloud
### Engineering
- Font [Anonymous Pro](https://www.marksimonson.com/fonts/view/anonymous-pro) - Mark Simonson
- Font [Cascadia](https://devblogs.microsoft.com/commandline/cascadia-code/) - This is a fun, new monospaced font that includes programming ligatures and is designed to enhance the modern look and feel of the Windows Terminal.
- Font [Inconsolata](https://fonts.google.com/specimen/Inconsolata) - Ralph Levien
- [CircleCI](https://circleci.com) - Enables you to reproduce the CircleCI environment locally
- [Docker](https://docker.com) - Docker Community Edition (.app)
- [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) - our default deployment platform
- [Hub](https://github.com/github/hub) - Add GitHub support to git on the command-line
- [JetBrains Toolbox](https://www.jetbrains.com/toolbox/app/) - One stop shopping for the best IDEs
- [mas](https://github.com/mas-cli/mas) - Mac App Store command line interface
- [postgresql](https://postgresql.org) - Object-relational database system
- [rbenv](https://github.com/rbenv/rbenv#readme) - Ruby version manager
- [redis](https://redis.org) - Persistent key-value database, with built-in net interface
- [yarn](https://yarnpkg.com) - JavaScript package manager
- [Zoom US](https://www.zoom.us/) - We default to Zoom for video conferencing
### Java
- [Gradle](https://www.gradle.org/) - Build automation
- [IntelliJ CE](https://www.jetbrains.com/idea/) - IntelliJ IDEA Community Edition
- [Java](https://openjdk.java.net/) - Latest Java SDK from OpenJDK
- [Maven](https://maven.apache.org/) - Java-based project management
### Mobile
- [AdoptOpenJDK 8](https://openjdk.java.net/projects/jdk8/) - Open source replace for Java8 (for Android)
- [Android Studio](https://developer.android.com/studio) - Android's IDE, built on the Eclipse IDE
### Web
- [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/home)
- [Elixir](https://elixir-lang.org/) - Functional metaprogramming aware language built on Erlang VM
- [Erlang](https://www.erlang.org/) - Programming language for highly scalable real-time systems
- [Firefox Quantum Developer Edition](https://www.mozilla.org/en-US/firefox/developer/) - Super cool web dev tools!
---
## Seed::Crystal Development
After checking out the repo, run `bin/setup` to install dependencies.
Many cask formulae can be found here: https://formulae.brew.sh/cask/
## Testing
- `bin/setup`
- `rake test`
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/carbonfive/seed-crystal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the Seed::Crystal project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/carbonfive/seed-crystal/blob/master/CODE_OF_CONDUCT.md).
## Inspirations
- https://github.com/thoughtbot/laptop
- https://github.com/pivotal/workstation-setup
- https://github.com/pivotal-sprout/sprout-wrap
- https://github.com/spilth/macOS
- https://github.com/robbyrussell/oh-my-zsh
- ... and many many others ...