aboutsummaryrefslogtreecommitdiffstats
path: root/README
blob: 12e6b44890f2f031214b10b40750042e88996d5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 _                                                                    
| |__   ___  _ __ ___  _ __ ___   ___  _ __ ___    ___ ___  _ __ ___  
| '_ \ / _ \| '_ ` _ \| '_ ` _ \ / _ \| '_ ` _ \  / __/ _ \| '_ ` _ \ 
| |_) | (_) | | | | | | | | | | | (_) | | | | | || (_| (_) | | | | | |
|_.__/ \___/|_| |_| |_|_| |_| |_|\___/|_| |_| |_(_)___\___/|_| |_| |_|

                                   (rhymes with "nom nom nom nom")

-------------------------------------------------------------------------------

BomMom: A web publishing/wiki system for electronics Bill of Materials (BOM) 

A work in progress as of April 2012. Written in golang.

### Instructions

Install golang compiler and run `go build` in this directory, then run the
`bommom` command to list available commands and options. 

### Basic Features

 - command line tools for managing part list files
 - web interface for publishing and editing BOMs
 - file-backed datastore for BOMs
 - import/export to CSV, JSON, and XML formats
 - Octopart API price fetching, with cache
 - mongodb-backed datastore for BOMs and web authentication

### Potential Extra Features

 - plugins and file format support for CAD software (Eagle, KiCad, etc)
 - HTTP JSON and XML APIs
 - "smart" spec parsing based on category hierarchy
 - SQL-backed datastore for BOMs and web authentication
 - auto-submit orders to major distributors
 - current inventory tracking
 - per-part statistics (eg, most popular parts)
 - git-backed BomStore
 - git post-commit hooks and/or github integration
 - Amazon, McMaster, eBay, Ali Baba, etc, price fetching
 - "Standard"/"Estimate" pricing modules for PCBs, assembly, etc
 - "sub-BOM" feature a la git sub-repositories

### Previous Work

 - [SKDB](http://opensourceecology.org/wiki/SKDB)
 - "[CAD](http://cad.devl.org/)"