xTuple
======
-xTuple Enterprise Resource Planning Mobile-Web client
-
[](https://travis-ci.org/xtuple/xtuple)
-### Installing this project
-
-*We strongly recommend that you install this project in a virtual
-machine created with our automated VM creation script:*
-[Creating a Virtual Development Environment using Vagrant](https://github.com/xtuple/xtuple-vagrant/blob/master/README.md)
-
-If you choose to install your own OS, whether on physical hardware or in a
-VM, we cannot support you. That said, the setup script in step 3 requires a
-64 bit Ubuntu machine. We have only tested this with Ubuntu 12.04. *If
-you do not have 64 bit hardware the install script will not work* and you
-will have to do a manual build. It is best if you do not already have
-postgres installed on your machine.
-
-#### 0. Fork this repository onto your own github account
-Navigate to http://github.com/xtuple/xtuple and click the FORK button.
-
-#### 1. Check out the xtuple repository
-We recommend checking out the latest tagged release. If you want to just
-check out the latest code you can skip the last step below (the 'git checkout').
-
- git clone --recursive git://github.com/<username>/xtuple.git
- cd xtuple
- git remote add XTUPLE git://github.com/xtuple/xtuple.git
- git fetch XTUPLE
- git checkout `git describe --abbrev=0`
+### What we're about
+
+xTuple is open-source business management software. The code is managed by an eponymous
+company in Norfolk, VA, and our community stretches around the world. Our web application
+is implemented as an [HTML5 node.js app](https://github.com/xtuple/xtuple/wiki/Overview).
+The other client to our server is a [desktop app](https://github.com/xtuple/qt-client) written
+in the cross-platform Qt framework.
+
+Most of our commercial customers are inventory-based manufacturers or distributors, and we have a
+fair amount of commercially-licensed code to specifically support these use-cases. That said,
+businesses of all sorts, even services-based companies, run their operations on our open-source
+core.
+
+We're always happy when people use xTuple as a launching point for their own projects,
+whether or not you have a commercial relationship with us.
+
+### Why you might be interested in hacking on our software
+
+The xTuple platform provides a great starting point for business software in practically
+any industry. What you get for free is an entire stack to work on top of, and a lot
+of business objects that you might want, like `Invoices`, `Currencies`, `Tasks` and
+`Contacts` (and about a hundred more) are already implemented.
+
+Moreover, one of the great strengths of the framework is extensibility and privilege
+control. Our extension system allows for a high level of modularity, and keeps you
+from having to rewrite the core. Fine-grained, centrally-managed privilege
+control is also an important feature that businesses typically want, and
+we've taken special care to implement it reliably across the application.
+
+### Getting involved
+
+Fork us, take a test drive with our [free trial](http://www.xtuple.com/free-trial),
+file a github issue.
+If you want to be a contributor and are looking for a place to
+make your mark, we're keeping a list of issues that are
+[fair game](https://github.com/xtuple/xtuple/labels/fair%20game)
+to pick off and provide
+a convenient, well-documented starting point into our project.
+
+In the month of August, we will be running haxTuple 2014. As in previous incarnations,
+we will open up our bug-shooting derby for the Qt client to our community, with prizes
+for the most effective bugsquashers! In this year's event, we will also introduce our
+new technologies by opening up our webapp for haxxing. Those who write the best
+JavaScript extensions or REST clients will get prizes. More details
+[here](https://github.com/xtuple/xtuple/wiki/haxTuple-2014).
+
+Also, don't miss the xTuple event of the year!
+[xTupleCon 2014](http://www.xtuple.com/xtuple-conference-2014)
+is going to be held October 13-18 in Norfolk, VA. With six days of events and a kickoff
+speech by Steve Wozniak, it promises to the be the biggest xTupleCon yet.
-#### 2. Run the install script
-
- bash scripts/install_xtuple.sh
-
-You will be prompted for `sudo` credentials; installation will take a few
-minutes.
-
-#### 3. Setup and run the server
-
- cd node-datasource
- node main.js
+### Installing this project
-Launch your local browser and navigate to the address `localhost:8888`. Default username and password are `admin`.
+The best way to start coding on our stack is to use our
+[Vagrant setup](https://github.com/xtuple/xtuple/wiki/Become-an-xTuple-Developer!).
### Release Notes
-View the [Release Notes](RELEASE.md) to see a change log.
+View the [Release Notes](https://github.com/xtuple/xtuple-documentation/tree/master/release-notes)
+to see a change log.
### Additional Resources
-
- * [How to Setup xTuple](https://github.com/xtuple/xtuple/wiki/How-to-set-up-xTuple)
- * [Creating a Virtual Development Environment using Vagrant](https://github.com/xtuple/xtuple-vagrant/blob/master/README.md)
- * [Architectural Overview](https://github.com/xtuple/xtuple/wiki/Overview)
* [Building an Extension Tutorial](https://github.com/xtuple/xtuple-extensions/blob/master/docs/TUTORIAL.md)
- * [API documentation](http://xtuple.com/jsdoc)
* [Developer Wiki](https://github.com/xtuple/xtuple/wiki)
+ * xTuple U [Tutorial Videos](https://github.com/xtuple/xtuple/wiki/Tutorial-Videos)
+ * [API documentation](http://xtuple.github.io/api/current)
+ * [Setting up a non-development demo environment](https://github.com/xtuple/xtuple/wiki/How-to-set-up-xTuple)
projects / xtuple / blobdiff