git.roojs.org Git - xtuple/blob - README.md

   1 xTuple
   2 ======
   3
   4 xTuple Enterprise Resource Planning Mobile-Web client
   5
   6 [![Build Status](https://travis-ci.org/xtuple/xtuple.png)](https://travis-ci.org/xtuple/xtuple)
   7
   8 ### Installing this project
   9
  10 *We strongly recommend that you install this project in a virtual
  11 machine created with our automated VM creation script:*
  12 [Creating a Virtual Development Environment using Vagrant](https://github.com/xtuple/xtuple-vagrant/blob/master/README.md)
  13
  14 If you choose to install your own OS, whether on physical hardware or in a
  15 VM, we cannot support you. That said, the setup script in step 3 requires a
  16 64 bit Ubuntu machine.  We have only tested this with Ubuntu 12.04.  *If
  17 you do not have 64 bit hardware the install script will not work* and you
  18 will have to do a manual build.  It is best if you do not already have
  19 postgres installed on your machine.
  20
  21 #### 0. Fork this repository onto your own github account
  22 Navigate to http://github.com/xtuple/xtuple and click the FORK button.
  23
  24 #### 1. Check out the xtuple repository
  25 We recommend checking out the latest tagged release. If you want to just
  26 check out the latest code you can skip the last step below (the 'git checkout').
  27
  28     git clone --recursive git://github.com/<username>/xtuple.git
  29     cd xtuple
  30     git remote add XTUPLE git://github.com/xtuple/xtuple.git
  31     git fetch XTUPLE
  32     git checkout `git describe --abbrev=0`
  33
  34 #### 2. Run the install script
  35
  36     bash scripts/install_xtuple.sh
  37
  38 You will be prompted for `sudo` credentials; installation will take a few
  39 minutes.
  40
  41 #### 3. Setup and run the server
  42
  43     cd node-datasource
  44     node main.js
  45
  46 Launch your local browser and navigate to the address `localhost:8888`. Default username and password are `admin`.
  47
  48 ### Release Notes
  49
  50 View the [Release Notes](RELEASE.md) to see a change log.
  51
  52 ### Additional Resources
  53
  54   * [How to Setup xTuple](https://github.com/xtuple/xtuple/wiki/How-to-set-up-xTuple)
  55   * [Creating a Virtual Development Environment using Vagrant](https://github.com/xtuple/xtuple-vagrant/blob/master/README.md)
  56   * [Architectural Overview](https://github.com/xtuple/xtuple/wiki/Overview)
  57   * [Building an Extension Tutorial](https://github.com/xtuple/xtuple-extensions/blob/master/docs/TUTORIAL.md)
  58   * [API documentation](http://xtuple.com/jsdoc)
  59   * [Developer Wiki](https://github.com/xtuple/xtuple/wiki)