Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/blimpio/boards

Install instructions and configuration files for Blimp Boards
https://github.com/blimpio/boards

Last synced: about 10 hours ago
JSON representation

Install instructions and configuration files for Blimp Boards

Awesome Lists containing this project

README

        

# Blimp Boards Install Guide

Install instructions and configuration files for Blimp Boards.

This project sets up all requirements to install and run:
- https://github.com/GetBlimp/boards-backend
- https://github.com/GetBlimp/boards-web
- https://github.com/GetBlimp/boards-sockets

Blimp Boards is also powered by [FilePreviews.io](http://filepreviews.io). While completely optional, if you'd like rich file previews generated for uploaded files, you're going to need to [sign up](https://api.filepreviews.io/auth/signup/) for an account to hook up with your install.

If you're looking for business class hosting and support, contact us: [email protected].

## Screenshot
![Blimp Boards Screenshot](http://i.imgur.com/ZpzUl3r.jpg)

## Getting Started

The following instructions will automatically download and provision a virtual machine for you to begin hacking on Blimp Boards with Vagrant.

1. Install Git: [http://git-scm.com/downloads](http://git-scm.com/downloads) (or [GitHub for Windows](http://windows.github.com/) if you want a GUI)
2. Install VirtualBox: [https://www.virtualbox.org/wiki/Downloads](https://www.virtualbox.org/wiki/Download]s)
3. Install Vagrant: [http://www.vagrantup.com](http://www.vagrantup.com) (We require Vagrant 1.1.2+ or later)
4. Open a terminal
5. Clone the project: `git clone https://github.com/getblimp/boards.git`
6. Enter the project directory: `cd boards`

## Using Vagrant for development

When you're ready to start working, boot the VM:

```
vagrant up
```

Note: The first time you do this, it will take a while as it downloads the VM image and installs it.

Once the machine has booted up, you can shell into it by typing:

```
vagrant ssh
```

Browse [http://localhost:8888/](http://localhost:8888/) to load the application.

### Shutting down the VM

```
vagrant halt
```

## TO-DO

- Dockerize port for production deployments