casbah

v0.1.6

Published

3 years ago

Contract Administration Site * Be Architecural Heroes *

Downloads

0High
0Medium
0Low

Architect Architectural Technologist Contract Administration Contract Management Change Management Deficiency Tracking Punch-list Site Resident Site Visit Report

CASBAH

C ontract A dmin S erver B e A rchitectural H eroes

Beta Version 0.1.4 to 0.9.9

Please note that casbah is still in it's beta stage of development with many features listed but not yet available. The development team is working throughout the Summer of 2018 and expects to have a post-beta version ready for Autumn. Thank you for your interest.

Casbah is an open source web-server and site that helps manage documents and workflows for Architectural Contract Administrators.

Casbah works by maintaining a couple of folder structures in it's working directory. The folder structures contain uploaded files as well as json files for storing data (Although casbah was initially built around a database this was dropped in favour of a strucuted file-system storage approach). An uploads folder structure keeps incoming CA documents of varying types such as drawings (pdf), GC billing (pdf), sketches(pdf), site photos (png, jpg). Casbah also provides an efficient way of generating documents from folders containing templates and images, for an example see reports/site reviews. A wiki folder structure keeps searchable casbah help and support articles as well as user entries for anything related to casbah, such as notes, tips, lessons learned etc.

Casbah log-in and multiple users are not supported at this time.

Installation

npm (windows)

For installation with node package manager (npm), ensure nodejs and npm are installed on your computer. To create a new node project, open a cmd window and enter the following...

>mkdir my_casbah
>cd my_casbah
>npm init

Install casbah as a node_module in the project...

>npm install casbah --save

In the working directory, create a javascript file 'casbah_start.js' with the following content, this will be the server launcher. You can copy this file from the node_modules/casbah folder. Note how this file defines the uploads and wiki folder names. These folders will be automatically created when casbah starts, if they don't already exist in the working directory.

///// casbah_start.js /////
global.appRoot=__dirname
global.uploads_dir="my_projects"
global.wiki_dir="my_wiki"
require("casbah")

When casbah_start.js is in your working directory, launch it with node to start the server thus...

>node casbah_start

The casbah server should be running and serving on port 8080. Open your favorate browser and navigate to the casbah web-site at http://localhost:8080/

git (windows)

Alternately, casbah can be installed with git directly from github. Ensure git is installed on your computer, open a cmd window and enter following...

>git clone https://github.com/asiddeley/casbah.git
>cd casbah
>npm install

Once the casbah is cloned (and folder structure created), the casbah server can be launched like so...

>cd casbah
>npm run cas

The casbah server should be running and serving on port 8080. Open your favorate browser and navigate to the casbah web-site at http://localhost:8080/

Introduction

In Architectural practice, a building project goes through various phases from concept to construction. Contact Administration (CA) is one of the latter phases and is the process of administering the contract between the Owner and Constructor to assist in getting the project built. Casbah facilitates this process by managing the paperwork.

Casbah is an open source web-server and site that helps manage documents and workflows for Architectural Contract Administrators.

Casbah works by maintaining a couple of folder structures in it's working directory. The folder structures contain uploaded files as well as json files for storing data (Although casbah was initially built around a database this was dropped in favour of a strucuted file-system storage approach). An uploads folder structure keeps incoming CA documents of varying types such as drawings (pdf), GC billing (pdf), sketches(pdf), site photos (png, jpg). Casbah also provides an efficient way of generating documents from folders containing templates and images, for an example see reports/site reviews. A wiki folder structure keeps searchable casbah help and support articles as well as user entries for anything related to casbah, such as notes, tips, lessons learned etc.

Casbah log-in and multiple users are not supported at this time.

Casbah Overview

Breakdown of the casbah main page and the 9 basic tabs follows...