Bnia Builder

Construct websites to explore and visualize your data.

Table of Contents

About
Requirements
Installation
Setup
Usage
Acknowledgements

About

THIS PROJECT IS UNDER DEVELOPMENT

Please contact BNIA-JFI to see how you can help.

The focus of this project is to enable folk to create data driven websites for visualization and exploration

Constructed by Charles Karpati of the Baltimore Neighborhood Indicators Association
More information may be found on Google Drive

Requirements

This application runs on an APACHE FILE SERVER
This application was built using NODE

• Node.js - Used in Development and for Installation
• phpMyAdmin - Used in Development And Production
• MySql - Used in Development And Production

Installation

1. git clone https://github.com/BNIA/bniaBuilder.git
   
2. cd bniaBuilder - Enter the directory
   
3. npm install - Install the dependencies
   

Setup

0. npm run start - (Developers only) Constructs a development enviornment for reworking the source code
   
1. npm run build - Generates optimized code for deployment inside a newly created dist/ directory.
   
2. Drop the dist/ directories content into a new path in your Website File-Server
3. Visit YourDomain.com/[path/to/folder/]admin to administer your site

Usage

Admin

• Styles
• Themes
• Component Configurations
• Component Placements
• User Permissions
• Manage Accounts & Views
• Specify Data Layers / Data Functions / Engagement

Users

• Filter Data
• Visualize Data
• Explore Data
• Add Data
• Disqus Data

Acknowledgements

Contributors

• Neha Chandupatla - Constructed database table structures for our housing API

A Special Thanks To

• Blue Raster - I started this project forking their Leaflet/React/Webpack example. At this point this project is radically different, but I had to start somewhere.
  
• Sabbir Ahmed - I rewrote Blue Rasters README using what I learnt from you. Your Notes and Batch scripts were also very informative reference material.
  
• Evan Mahone - Your documentation taught me a lot and and the initial Green Patterns map proved invaluable when constructing this architecture.
  
• David Carpenter - For taking care of BNIA when I could not. I've improved my PHP because of you.
  

License

MIT License

Copyright (c) 2018 Charles Karpati

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---