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

   1 xTuple
   2 ======
   3
   4 xTuple Enterprise Resource Planning Mobile-Web client
   5
   6
   7 ### Installing this project
   8
   9 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.
  10
  11 To install this project, first fork this repo onto your own github account and clone it into your preferred source directory. We recommend checking out the latest tagged release, but if you want to just checkout the lastest code you can skip this next step. Find and checkout the latest tag with the following:
  12
  13     git remote add XTUPLE git://github.com/xtuple/xtuple.git
  14     git fetch XTUPLE
  15     git checkout `git describe --abbrev=0`
  16
  17 Then run:
  18
  19     cd scripts
  20     sudo ./install_xtuple.sh
  21
  22 This will take a while. Then, to start the datasource, run
  23
  24     cd ../node-datasource
  25     sudo ./main.js
  26
  27 Launch your local browser and navigate to the address `localhost`. Default username and password are `admin`.
  28
  29 ### Release Notes
  30
  31 View the [Release Notes](RELEASE.md) to see a change log.
  32
  33 ### Additional Resources
  34
  35   * [Setting up an Ubuntu Virtual Machine](https://github.com/xtuple/xtuple/wiki/Setting-up-an-Ubuntu-Virtual-Machine)
  36   * [Architectural Overview](https://github.com/xtuple/xtuple/wiki/Overview)
  37   * [Building an Extension Tutorial](https://github.com/xtuple/xtuple-extensions/blob/master/docs/TUTORIAL.md)
  38   * [API documentation](http://xtuple.com/jsdoc)
  39   * [Developer Wiki](https://github.com/xtuple/xtuple/wiki)