Git Product home page Git Product logo

framework's Introduction

Four Bean Soup Broth

Four Bean Soup is a web application development company (mainly Josh Owens). We focus on creating smart, usable web sites built on a foundation of clean, extensible, handcrafted code. We eat our own dog food, we use Broth as our core starting point to ensure consistency through-out our applications. We cook all our goodness in here, Once.

Broth is built with certain specific standards and opinions in mind. We were tired of re-writing and copy & pasting the same code over and over from project to project. Then git came along. Git helped us realize there was a better way.

Key Concepts

  • Make the app extensible by offering smart hooks for engines and plugins to add functionality
  • Keep the code clean. Break repeating code out into partials and re-use as needed
  • Write semantic HTML/Haml. Of course clean, organized CSS/Sass goes with that. And with the help of Compass, we get to ensure that we keep our CSS/Sass DRY
  • Tests, tests, tests. If you aren’t testing. You are wrong.

Opinionated Choices

Gotchas

  • We try to use “Markers” in key files, such as routes and application.js. We do this to ensure that continued foundation development doesn’t trample continued application development
  • Don’t annotate the models in the base Broth application. You should only be annotating the models in your real application

Installation Steps (development)

1. mkdir My-Broth-App
2. cd My-Broth-App
3. git init
4. git remote add foundation git://github.com/fourbeansoup/broth.git
5. git pull foundation master
6. git remote add origin [email protected]:me/my-broth-app.git
7. cp config/database.example.yml config/database.yml
8. Confirm database setup in config/database.yml
9. sudo gem sources -a http://gemcutter.org/
10. sudo gem install chronic
11. rake gems:install
12. rake db:create
13. rake db:migrate
14. rake db:seed
15. compass

License

See LICENSE file

framework's People

Contributors

cwsaylor avatar m3talsmith avatar mjonuschat avatar queso avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.