Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Port docs to markdown with some updates.
- Loading branch information
Showing
6 changed files
with
190 additions
and
189 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
We currently support installing on Debian 5.0 Lenny and Ubuntu 12.04 | ||
systems. | ||
|
||
Install Ruby’n’Rails | ||
-------------------- | ||
|
||
Bookyt is developed and tested using Rails 3.2 and Ruby 1.9.3. | ||
|
||
Install packages needed: | ||
|
||
sudo apt-get install rubygems irb libruby-extras libxml2-dev libxslt-dev ruby-dev build-essential | ||
sudo apt-get install git | ||
|
||
Then some gems: | ||
|
||
sudo gem install rake bundler | ||
|
||
Testing | ||
------- | ||
|
||
You currently need phantomjs version 1.8.1 or newer. You can get this on | ||
Ubuntu 13.10. | ||
|
||
Install Bookyt | ||
-------------- | ||
|
||
Install current Bookyt from git repository. We’ll use this checkout as | ||
working directory from now on: | ||
|
||
git clone http://github.com/huerlisi/bookyt.git | ||
cd bookyt | ||
|
||
Install dependency gems: | ||
|
||
bundle | ||
|
||
Setup database: | ||
|
||
Copy database.yml.example to database.yml and edit as needed. | ||
|
||
cp config/database.yml.example config/database.yml | ||
|
||
Initialize the database: | ||
|
||
bundle exec rake db:setup | ||
|
||
Setup admin user | ||
---------------- | ||
|
||
There’s a rake task to setup an admin user: | ||
|
||
bundle exec rake users:admin | ||
|
||
Create account types | ||
-------------------- | ||
|
||
Account types need to be named correctly for calculation of the balance | ||
sheet and profit sheet. | ||
|
||
See db/seeds/locales for your convenience. | ||
|
||
### Run | ||
|
||
You should now be able to start Bookyt: | ||
|
||
rails server | ||
|
||
Bookyt is now available at http://localhost:3000 | ||
|
||
Enjoy! |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
Bookyt | ||
====== | ||
|
||
Bookyt is a bookkeeping/ERP application designed for | ||
small-to-medium-sized companies. | ||
|
||
It can handle debit invoices, credit invoices, projects with timelogs, | ||
swiss salary management, and much more. | ||
|
||
Demo | ||
---- | ||
|
||
Here you find a demo installation of | ||
[Bookyt](http://bookyt.demo.cyt.ch). | ||
|
||
Features | ||
-------- | ||
|
||
Bookyt is a web application implementing double-entry bookkeeping | ||
providing: | ||
|
||
We try stick with the slogan ‘Keep it simple, stupid’. The interface | ||
follows modern industrial design rules. All pages try to give you just | ||
enough information to do the task while being simple. Dynamic elements | ||
such as inline editing are used sparsely, but are there where | ||
appreciated. | ||
|
||
- Customizable accounts | ||
- Booking wizard | ||
- Booking templates | ||
- Earnings report | ||
- Balance sheet | ||
- Invoicing | ||
- Accounts Receivable | ||
- Accounts Payable | ||
- Employee expense voucher | ||
- Depreciation | ||
- Setting up tax tables | ||
|
||
Find more information about Bookyt on its [homepage](http://bookyt.ch) | ||
|
||
Bookyt is built on [Ruby On Rails](http://www.rubyonrails.org) and | ||
released as [Open Source](http://www.opensource.org). | ||
|
||
Documentation | ||
------------- | ||
|
||
- [Installation](https://github.com/huerlisi/bookyt/blob/master/INSTALL.md) | ||
- [Upgrade](https://github.com/huerlisi/bookyt/blob/master/UPGRADE.md) | ||
|
||
Contributing | ||
------------ | ||
|
||
- [Travis CI](https://travis-ci.org/huerlisi/bookyt.png) | ||
- [CodeClimate](https://codeclimate.com/github/huerlisi/bookyt.png) | ||
|
||
Code is available at [github](https://github.com/huerlisi/bookyt). | ||
|
||
License | ||
------- | ||
|
||
Copyright 2007-2015 Simon Hürlimann <simon.huerlimann@cyt.ch> | ||
Copyright 2010-2012 Ramon Egloff <ramon.egloff@cyt.ch> | ||
Copyright 2010-2012 Roman Simecek <roman.simecek@cyt.ch> | ||
Copyright 2011-2013 Andi Staub <andi.staub@cyt.ch> | ||
|
||
This program is free software: you can redistribute it and/or modify | ||
it under the terms of the GNU Affero General Public License as | ||
published by the Free Software Foundation, either version 3 of the | ||
License, or (at your option) any later version. | ||
|
||
This program is distributed in the hope that it will be useful, | ||
but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
GNU Affero General Public License for more details. | ||
|
||
You should have received a copy of the GNU Affero General Public License | ||
along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
Upgrade from Bookyt 1.5 to 2.0 | ||
============================== | ||
|
||
Bookyt 2.0 uses a different database system and supports multi tenancy. | ||
This makes some manual steps necessary. Follow these instruction to enjoy all | ||
the new features of Bookyt 2.0. | ||
|
||
If you do not yet run the latest Bookyt 1.x release, please first | ||
upgrade to release 1.5. It is available on github in the stable-1-5 branch. | ||
|
||
Backup Data | ||
----------- | ||
|
||
bundle exec rails runner 'Backup.dump("upgrade-to-2.0.zip")' | ||
|
||
Create PostgreSQL database | ||
-------------------------- | ||
|
||
This is how it’s done on Debian/Ubuntu. Please submit a patch if you’ve | ||
figured out the steps on another system. | ||
|
||
sudo apt-get install postgresql | ||
|
||
sed 's/\*mysql/*postgres/' -i 'config/database.yml' | ||
|
||
Lookup current username, password and database from config/database.yml | ||
and use them in the following commands. | ||
|
||
sudo -u postgres -i | ||
createuser $USER_NAME --no-createdb --no-createrole --no-superuser --pwprompt | ||
createdb --owner $USER_NAME $DATABASE_NAME | ||
|
||
On a development system, you probably also want to do the steps for | ||
both the development and test databases. | ||
|
||
Restore Data | ||
------------ | ||
|
||
Now import the data again. | ||
|
||
bundle exec rails runner 'Backup.restore "upgrade-to-2.0.zip"' |
This file was deleted.
Oops, something went wrong.