Labs/Bespin/DeveloperGuide/Setup: Difference between revisions

← Older edit

Labs/Bespin/DeveloperGuide/Setup (view source)

Revision as of 07:23, 23 June 2010

127 bytes added , 23 June 2010

no edit summary

J4c

27

edits

@@ Line 1: / Line 1: @@
 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 ==
@@ Line 12: / Line 6: @@
 *Mercurial
-*Git
 *Python 2.5 or 2.6
-*Ruby 1.8 or 1.9 (1.9 is faster)
-*The following RubyGems: <tt>rack jeweler json_pure extlib erubis thor</tt>
-  <code>gem install rack jeweler json_pure extlib erubis thor</code>
+Python 2.6 is preferred.
-Optionally, you may want the <tt>thin</tt> library, which will improve performance over the default WEBrick.
+'''NOTE FOR LINUX USERS:''' ''If you are running on a Linux system, you will likely need a "python-dev" and "ruby1.8-dev" (on Ubuntu; possibly "python-devel" elsewhere) package installed, if you do not already have it. If you want to build the embedded release, you will want libyaml: the package on Ubuntu is "libyaml-dev".''
-  <code>gem install thin</code>
-'''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.''
@@ Line 43: / Line 30: @@
      python bootstrap.py --no-site-packages
-to get the environment set up. This is built around [http://pypi.python.org/pypi/virtualenv virtualenv].
+to get the environment set up. This is built around [http://pypi.python.org/pypi/virtualenv virtualenv]. Please watch for helpful hints and instructions on screen.
+In Unix-like environments, the next step is to activate the virtualenv using this command:
+    source bin/activate
+on Windows, the command is Scripts/activate.bat
+Once the virtualenv is activate, you need to get the server set up:
+    paver install_server
+And the first time around, you're also going to want to get a database set up:
+    paver create_db
+If you have some trouble on macos x like the error message: ImportError: No module named `xxx'
+It's probably cause the server side is not completely installed so try
+    cd ../bespinserver
+    paver develop
+    paver create_db
+==Starting the development server==
+If you are no longer (or not yet) in the virtualenv environment run within the bespinclient directory:
+  source bin/activate
+To start the server execute:
+  paver start
-After running the bootstrap script, please follow the additional instructions that are displayed on the screen.
+This will start the Bespin server. You can now access the Bespin editor at http://localhost:8080/ in you browser.
-''Note'': Currently (2009-11-10), Bespin is using a specific branch of SproutCore ("tiki"). <tt>bootstrap.py</tt> will fetch it for you, but if you need to fetch it yourself, invoke <tt>paver install_sproutcore</tt>.
+Have fun!
 ==More Documentation==
-Documentation can be found in the docs directory of "bespinclient".
+The documentation of the last release is [https://bespin.mozillalabs.com/docs/ here].
 ==Contributing to Bespin==