spontaneousplankton/appbutler

A visualization tool for node.js

Butler

Butler provides an intuitive drag-and-drop UI for designing server architecture. It will generate a boilerplate from your configuration and send your files to github. Then clone your new repo and start coding!

Note:Butler currently only supports express.js servers.

---

Team

• Product Owner: Reid Greer
• Scrum Master: Sofia Berlin
• Development Team Members: Dylan Kuang, Jeremy Rosenfeld, Reid Greer, Sofia Berlin

---

## Table of Contents

1. Usage
2. Features
3. Requirements
4. Development
   1. Installing Dependencies
5. Contributing
6. Architecture
7. API
8. Deployment

---

Usage

1. Navigate your browser to appButler.io.
2. Login with Github. AppButler needs github authorization to create a new repo.
3. Drag and drop components until you are satisfied with your server architecture.
4. Click build to generate your boilerplate
5. Start coding!

---

Features

1. Support for express.js server generation
2. Integration with Github
3. An intuitive UI to help you visualize and design your server architecture
4. Ability to save and return to past server configurations

---

Requirements

• Node >= 5.0.x < 6
• Express
• Mongo 3.2.x
  • Mongoose 4.4.x
• React
• Redux

---

Development

Installing Dependencies

From within the root directory:

npm install
npm run build

Contributing + Github Workflow

See contributing.md for contribution and github workflow guidelines.

---

Architecture

High Level Architecture

Database

---

API

Method	Route	Description
POST	api/serve	Generate a boilerplate and sends it to github
GET	api/config	Get current user's configs from the database
POST	api/serve	Generate a new config
POST	api/config	Save a user's config to the database
DELETE	api/config	Delete a user's config
POST	api/login	Log in user through Github
GET	api/users	Get current user from the database