500 Lines or Less
JavaScript Python Haskell Ruby Clojure Erlang Other
Latest commit 4b55a2e Jul 5, 2016 @MichaelDiBernardo MichaelDiBernardo committed on GitHub Update BUILD.md
Permalink
Failed to load latest commit information.
_build Minimal HTML build; styles not working yet. May 30, 2015
blockcode Fix test print issues from Jun 19, 2016
ci Fix test print issues from Jun 19, 2016
cluster Fix test print issues from Jun 19, 2016
contingent Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
crawler Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
dagoba Fixups. Jul 2, 2016
data-store Fix data-store README.rst format error May 31, 2016
epub Make epub a bit easier to build; add build instructions. Jul 5, 2016
event-web-framework Fixups. Jul 2, 2016
flow-shop Final typeset to remove orphans + widows. Apr 16, 2016
functionalDB Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
html Fixups. Jul 2, 2016
image-filters Fix test print issues from Jun 19, 2016
incomplete Archive tiled renderer chapter. Feb 3, 2016
interpreter Add warning about versions. May 29, 2016
minutiae Create markdown intro for web publishing. Jul 2, 2016
modeller Fix test print issues from Jun 19, 2016
objmodel Fix test print issues from Jun 19, 2016
ocr Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
pedometer Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
resource Update readme with logo. Feb 27, 2015
same-origin-policy Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
sampler Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
spreadsheet Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
static-analysis Final typeset to remove orphans + widows. Apr 16, 2016
template-engine Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
tex We don't need .tex sources anymore. Apr 9, 2016
web-server Fix issues from @amyrbrown's amazing proofread. Jun 27, 2016
.gitignore We don't need .tex sources anymore. Apr 9, 2016
BUILD.md Update BUILD.md Jul 5, 2016
LICENSE.md Initializing repository for '500 Lines or Less'. Nov 4, 2013
README.md Fix typos. Apr 9, 2016
build.py Make epub a bit easier to build; add build instructions. Jul 5, 2016
requirements.txt Minimal HTML build; styles not working yet. May 30, 2015

README.md

500 Lines or Less

"What I cannot create, I do not understand."

-- Richard Feynman

This is the source for the book 500 Lines or Less, the fourth in the Architecture of Open Source Applications series. As with other books in the series, all written material will be covered by the Creative Commons - Attribution license, and all code by the MIT License: please see the license description for details. In addition, all royalties from paid-for versions will all go to Amnesty International.

The production of this book has been made possible by the financial support of PagerDuty.

PagerDuty Logo

Mission

Every architect studies family homes, apartments, schools, and other common types of buildings during her training. Equally, every programmer ought to know how a compiler turns text into instructions, how a spreadsheet updates cells, and how a database efficiently persists data.

Previous books in the AOSA series have done this by describing the high-level architecture of several mature open-source projects. While the lessons learned from those stories are valuable, they are sometimes difficult to absorb for programmers who have not yet had to build anything at that scale.

"500 Lines or Less" focuses on the design decisions and tradeoffs that experienced programmers make when they are writing code:

  • Why divide the application into these particular modules with these particular interfaces?
  • Why use inheritance here and composition there?
  • How do we predict where our program might need to be extended, and how can we make that easy for other programmers?

Each chapter consists of a walkthrough of a program that solves a canonical problem in software engineering in at most 500 source lines of code. We hope that the material in this book will help readers understand the varied approaches that engineers take when solving problems in different domains, and will serve as a basis for projects that extend or modify the contributions here.

Contributors

Name Affiliation Project Online GitHub
Mike DiBernardo Wave editorial MichaelDiBernardo
Amy Brown indie editorial amyrbrown
Allison Kaptur Dropbox byterun akaptur
Audrey Tang g0v.tw, Socialtext, Apple spreadsheet audreyt
Brandon Rhodes Dropbox contingent brandon-rhodes
Carl Friedrich Bolz King's College London object model cfbolz
Cate Huston   Image Filter app catehstn
Christian Muise University of Melbourne flow-shop haz
Daniel Jackson   same-origin-policy    
Daniel Rocco BrightLink Technology contingent drocco007
Dann Toliver Bento Box dagoba dxnn
Dessy Daskalov Nudge Rewards Pedometer dessy
Dethe Elza   blockcode   dethe
Dustin Mitchell Mozilla cluster   djmitche
Erick Dransch   Modeller EkkiD
Eunsuk Kang   same-origin-policy    
Greg Wilson   web-server gvwilson
Guido van Rossum Dropbox crawler gvanrossum
A. Jesse Jiryu Davis MongoDB crawler ajdavis
Jessica Hamrick University of California, Berkeley sampler jhamrick
Leah Hanson Google static analysis astrieanna
Leo Zovic   event-web-framework    
Malini Das Twitch ci malini
Marina Samuel Mozilla ocr emtwo
Ned Batchelder edX templating engine nedbat
Santiago Perez De Rosso   same-origin-policy    
Taavi Burns Previously at Points, now at PagerDuty data-store taavi
Yoav Rubin Microsoft In-memory functional database yoavrubin

Technical Reviewers

Amber Yust Andrew Gwozdziewycz Andrew Kuchling
Andrew Svetlov Andy Shen Anton Beloglazov
Ben Trofatter Borys Pierov Carise Fernandez
Charles Stanhope Chris Atlee Chris Seaton
Cyryl Płotnicki-Chudyk Dan Langer Dan Shapiro
David Pokorny Eric Bouwers Frederic De Groef
Graham Lee Gregory Eric Sanderson James O'Beirne
Jan de Baat Jana Beck Jessica McKellar
Jo Van Eyck Joel Crocker Johan Thelin
Johannes Fürmann John Morrissey Joseph Kaptur
Josh Crompton Joshua T. Corbin Kevin Huang
Maggie Zhou Marc Towler Marcin Milewski
Marco Lancini Mark Reid Matthias Bussonnier
Max Mautner Meggin Kearney Mike Aquino
Natalie Black Nick Presta Nikhil Almeida
Nolan Prescott Paul Martin Piotr Banaszkiewicz
Preston Holmes Pulkit Sethi Rail Aliiev
Ronen Narkis Rose Ames Sina Jahan
Stefan Turalski William Lachance