nihey / ACLU

Code for Hawaii + ACLU app to show public access rights

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Code for Hawaii + ACLU

Access to public lands in Hawai`i App

Welcome! Code for Hawaii has partnered with the American Civil Liberties Union of Hawai`i ("ACLU") to create an app. The intent of the proposed app is to use your geo-location to assist understanding of whose land you are on and your civil rights there.

Please start by reading the project proposal.

Questions? Want to help?
Come join us on Wednesday nights at the Code for Hawaii meetups. We meet the first three Wednesdays of the month. (Contact Ryan for Saturday morning hack sessions too).

Quick Links

Development / Getting Started

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

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

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.

Creating the VM

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!

Running a shell in the VM

vagrant ssh

Getting the app up and running

After running vagrant up, you'll want to perform the following:

vagrant ssh
/var/project-aclu/etc/start.sh
/var/project-aclu/backend/etc/seed_fake_park_data.sh

After these commands are run, you should be able to go to http://localhost:50808 and see something.

About

Code for Hawaii + ACLU app to show public access rights


Languages

Language:JavaScript 33.0%Language:Vue 25.6%Language:Shell 21.2%Language:Python 19.2%Language:CSS 0.5%Language:HTML 0.3%Language:Makefile 0.1%