Labs/Bespin/DeveloperGuide/Setup: Difference between revisions
Olleolleolle (talk | contribs) (made the Ruby gems line a list of) |
Olleolleolle (talk | contribs) m (→Prerequisites: formatting of the gem install section) |
||
| Line 7: | Line 7: | ||
Consider this your official warning that ''there be dragons here''. | Consider this your official warning that ''there be dragons here''. | ||
==Prerequisites== | == Prerequisites == | ||
You will need the following installed on your system to get Bespin up and running: | You will need the following installed on your system to get Bespin up and running: | ||
* Mercurial | *Mercurial | ||
* Git | *Git | ||
* Python 2.5 or 2.6 | *Python 2.5 or 2.6 | ||
* Ruby | *Ruby | ||
* The following Ruby Gems: | *The following Ruby Gems: rack jeweler json_pure extlib erubis thor | ||
<code>gem install rack jeweler json_pure extlib erubis thor</code> | |||
'''NOTE FOR MAC USERS:''' ''You will need Xcode installed.'' | '''NOTE FOR LINUX USERS:''' ''If you are running on a Linux system, you will likely need a "python-dev" (on Ubuntu; possibly "python-devel" elsewhere) package installed, if you do not already have it.'' | ||
'''NOTE FOR MAC USERS:''' ''You will need Xcode installed.'' | |||
'''NOTE FOR WINDOWS USERS:''' ''Most Bespin developers are using unix-like platforms. Bespin's server should be able to run on Windows, though. You'll need a C compiler, and you can use Microsoft's free [http://www.microsoft.com/Express/VC/ Visual C++] compiler. As an alternative, you can use [http://www.cygwin.com/ Cygwin] or [http://www.mingw.org/ MinGW] to have a unix-like environment on your Windows system.'' | '''NOTE FOR WINDOWS USERS:''' ''Most Bespin developers are using unix-like platforms. Bespin's server should be able to run on Windows, though. You'll need a C compiler, and you can use Microsoft's free [http://www.microsoft.com/Express/VC/ Visual C++] compiler. As an alternative, you can use [http://www.cygwin.com/ Cygwin] or [http://www.mingw.org/ MinGW] to have a unix-like environment on your Windows system.'' | ||
Revision as of 16:53, 10 November 2009
Thanks for downloading the code to the Bespin project. You can easily get Bespin's Python server running on your local Mac or Linux machine (see note about Windows below).
Current Status Note
We are in the middle of a process that we're calling the "Reboot". It's not a rewrite of Bespin, but a major refactoring. The current developer setup process is not as simple as it will ultimately become, and the Bespin that you'll have at the end of it is missing a lot.
Consider this your official warning that there be dragons here.
Prerequisites
You will need the following installed on your system to get Bespin up and running:
- Mercurial
- Git
- Python 2.5 or 2.6
- Ruby
- The following Ruby Gems: rack jeweler json_pure extlib erubis thor
gem install rack jeweler json_pure extlib erubis thor
NOTE FOR LINUX USERS: If you are running on a Linux system, you will likely need a "python-dev" (on Ubuntu; possibly "python-devel" elsewhere) package installed, if you do not already have it.
NOTE FOR MAC USERS: You will need Xcode installed.
NOTE FOR WINDOWS USERS: Most Bespin developers are using unix-like platforms. Bespin's server should be able to run on Windows, though. You'll need a C compiler, and you can use Microsoft's free Visual C++ compiler. As an alternative, you can use Cygwin or MinGW to have a unix-like environment on your Windows system.
Getting Started
Run:
hg clone http://hg.mozilla.org/labs/bespinclient hg clone http://hg.mozilla.org/labs/bespinserver cd bespinclient
This will get the Bespin client and Python Bespin server code checked out. The bespinclient/ directory is the "main" directory that you'll use. (See the Using Mercurial article for more detailed instructions on using Mercurial.)
To set up Bespin for the first time, run:
python bootstrap.py --no-site-packages
to get the environment set up. This is built around virtualenv.
After running the bootstrap script, please follow the additional instructions that are displayed on the screen.
More Documentation
Documentation can be found in the docs directory of "bespinclient".
Contributing to Bespin
For details see: