We're just getting started, stay tuned!
For now, please help fill out the project board.
To provide a consistent development setup, we've made scripts to provision a Linux virtual machine that runs Docker containers. "yo 🐶..."
If you don't know what that means, read the sections below. ⬇️
If you do, just make sure you have VirtualBox (v5.0+) and vagrant (v 1.9+), then run vagrant up. 👏
VirtualBox is a product from Oracle that runs an entire Operating System (the "guest OS") inside the VirtualBox program on your computer (the "host OS").
❓ Why on 🌎 would you want that?
A: This allows us to encapsulate the entire development environment in the guest OS without having to modify your host OS. Thus, we can install all the development tools we need without worrying about potentially breaking any configuration on your computer. It also gives us a common OS (Linux) that we know things will work on. 😃
Please download VirtualBox here for your host OS and install it.
Vagrant is a HashiCorp product that provides a convenient scripting interface to control VirtualBox and manage Virtual Machines.
❓ Again, why do you need this?
A: Vagrant allows us to automatically configure the guest OS/VM exactly how we want it in a consistent fashion. This means you won't have to spend time downloading, installing, and configuring the correct versions of development tools (e.g. node, yarn, python, httpie, docker, etc..) to setup your build environment.
Please download Vagrant here for your OS and install it.
After VirtualBox and Vagrant are installed, run the following command from the root directory of the aclu repo:
vagrant up
...and maybe grab some ☕ and 🍩 -- depending on your internet connection, this may take awhile!
vagrant ssh