akaunting/README.md

71 lines
3.3 KiB
Markdown
Raw Normal View History

2018-10-01 17:22:13 +03:00
# Akaunting™
2017-09-14 22:21:00 +03:00
2019-11-16 10:21:14 +03:00
![Latest Stable Version](https://img.shields.io/github/release/akaunting/akaunting.svg) ![Total Downloads](https://img.shields.io/github/downloads/akaunting/akaunting/total.svg) [![Crowdin](https://d322cqt584bo4o.cloudfront.net/akaunting/localized.svg)](https://crowdin.com/project/akaunting) ![Build Status](https://travis-ci.com/akaunting/akaunting.svg)
2017-09-14 22:21:00 +03:00
2019-11-16 10:21:14 +03:00
Akaunting is a free, open source and online accounting software designed for small businesses and freelancers. It is built with modern technologies such as Laravel, VueJS, Bootstrap 4, RESTful API etc. Thanks to its modular structure, Akaunting provides an awesome App Store for users and developers.
2017-09-14 22:21:00 +03:00
* [Home](https://akaunting.com) - The house of Akaunting
* [Blog](https://akaunting.com/blog) - Get the latest news
2018-03-08 11:30:15 +03:00
* [Forum](https://akaunting.com/forum) - Ask for support
* [Documentation](https://akaunting.com/docs) - Learn how to use
* [Translations](https://crowdin.com/project/akaunting) - Akaunting in your language
2017-09-14 22:21:00 +03:00
## Requirements
2019-11-16 10:21:14 +03:00
* PHP 7.2 or higher
2017-09-14 22:21:00 +03:00
* Database (eg: MySQL, PostgreSQL, SQLite)
* Web Server (eg: Apache, Nginx, IIS)
* [Other libraries](https://akaunting.com/docs/requirements)
## Framework
2019-11-16 10:21:14 +03:00
Akaunting uses [Laravel](http://laravel.com), the best existing PHP framework, as the foundation framework and [Module](https://github.com/akaunting/module) package for Apps.
2017-09-14 22:21:00 +03:00
## Installation
2019-11-16 10:21:14 +03:00
* Install [Composer](https://getcomposer.org/download)
* Download the [repository](https://github.com/akaunting/akaunting/archive/master.zip) and unzip into your server
* Open and point your command line to the directory you unzipped Akaunting
* Run the following command: `composer install`
* Finally, launch the [installer](https://akaunting.com/docs/installation)
2017-12-31 05:29:02 +11:00
2017-09-14 22:21:00 +03:00
## Contributing
Please, be very clear on your commit messages and pull requests, empty pull request messages may be rejected without reason.
When contributing code to Akaunting, you must follow the PSR coding standards. The golden rule is: Imitate the existing Akaunting code.
2017-12-07 11:34:44 +03:00
Please note that this project is released with a [Contributor Code of Conduct](https://akaunting.com/conduct). By participating in this project you agree to abide by its terms.
2017-09-14 22:21:00 +03:00
## Translation
If you'd like to contribute translations, please check out our [Crowdin](https://crowdin.com/project/akaunting) project.
## Changelog
Please see [Releases](../../releases) for more information what has changed recently.
## Security
2017-09-23 16:46:50 +03:00
If you discover any security related issues, please email security@akaunting.com instead of using the issue tracker.
2017-09-14 22:21:00 +03:00
## Credits
2019-11-16 10:21:14 +03:00
* [Denis Duliçi](https://github.com/denisdulici)
* [Cüneyt Şentürk](https://github.com/cuneytsenturk)
* [All Contributors](../../contributors)
2019-11-16 10:21:14 +03:00
## Partners
2019-11-16 10:21:14 +03:00
Each of our partners can help you craft a beautiful, well-architected project. Feel free to get in [contact](https://akaunting.com/contact) with us to become a partner.
2019-11-16 10:21:14 +03:00
* [Creative Tim](https://www.creative-tim.com) is our design partner since Akaunting 2.0 version. They create beautiful UI Kits, Templates, and Dashboards built on top of Bootstrap, Vue.js, React, Angular, Node.js, and Laravel.
## Sponsors
2019-11-16 10:21:14 +03:00
Support Akaunting by becoming a sponsor on [Patreon](https://www.patreon.com/akaunting). Your logo will show up here with a link to your website.
2017-09-14 22:21:00 +03:00
## License
Akaunting is released under the [GPLv3 license](LICENSE.txt).