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 The install script for this project is Debian based and designed to run on a 64 bit Ubuntu 12.04 machine. *If you do not have 64 bit hardware the install script will not work for you* and you will have to do a manual build. It is best if you do not already have postgres installed on your machine.
  11
  12 #### 1. Fork this repo onto your own github account
  13 We recommend checking out the latest tagged release, but if you want to just
  14 checkout the lastest code you can skip this next step. Find and checkout the
  15 latest tag with the following:
  16
  17     git clone --recursive git://github.com/<username>/xtuple.git
  18     cd xtuple
  19     git remote add XTUPLE git://github.com/xtuple/xtuple.git
  20     git fetch XTUPLE
  21     git checkout `git describe --abbrev=0`
  22
  23 #### 2. Run the install script
  24
  25     bash scripts/install_xtuple.sh
  26
  27 You will be prompted for `sudo` credentials; installation will take a few
  28 minutes.
  29
  30 #### 3. Setup and run the server
  31
  32     cd node-datasource
  33     node main.js
  34
  35 Launch your local browser and navigate to the address `localhost:8888`. Default username and password are `admin`.
  36
  37 ### Release Notes
  38
  39 View the [Release Notes](RELEASE.md) to see a change log.
  40
  41 ### Additional Resources
  42
  43   * [How to Setup xTuple](https://github.com/xtuple/xtuple/wiki/How-to-set-up-xTuple)
  44   * [Creating a Virtual Development Environment using Vagrant](https://github.com/xtuple/xtuple-vagrant/blob/master/README.md)
  45   * [Architectural Overview](https://github.com/xtuple/xtuple/wiki/Overview)
  46   * [Building an Extension Tutorial](https://github.com/xtuple/xtuple-extensions/blob/master/docs/TUTORIAL.md)
  47   * [API documentation](http://xtuple.com/jsdoc)
  48   * [Developer Wiki](https://github.com/xtuple/xtuple/wiki)