2018-10-01 17:22:13 +03:00
# Akaunting™
2017-09-14 22:21:00 +03:00
2019-12-21 15:57:13 +03:00
[](https://github.com/akaunting/akaunting/releases)
[](https://crowdin.com/project/akaunting)
2023-02-14 23:48:33 +03:00
[](https://github.com/akaunting/akaunting/actions)
2019-12-21 15:57:13 +03:00
[](LICENSE.txt)
2017-09-14 22:21:00 +03:00
2022-06-01 10:15:55 +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, Tailwind, 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
2018-03-08 11:30:15 +03:00
* [Forum ](https://akaunting.com/forum ) - Ask for support
2023-02-24 12:10:10 +03:00
* [Documentation ](https://akaunting.com/hc/docs ) - Learn how to use
2021-07-03 01:50:08 +03:00
* [Developer Portal ](https://developer.akaunting.com ) - Generate passive income
2019-12-07 15:54:03 +03:00
* [App Store ](https://akaunting.com/apps ) - Extend your Akaunting
* [Translations ](https://crowdin.com/project/akaunting ) - Help us translate Akaunting
2017-09-14 22:21:00 +03:00
## Requirements
2022-06-01 10:15:55 +03:00
* PHP 8.0 or higher
2017-09-14 22:21:00 +03:00
* Database (eg: MySQL, PostgreSQL, SQLite)
* Web Server (eg: Apache, Nginx, IIS)
2023-02-24 12:10:10 +03:00
* [Other libraries ](https://akaunting.com/hc/docs/on-premise/requirements/ )
2017-09-14 22:21:00 +03:00
## 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-12-07 15:54:03 +03:00
* Install [Composer ](https://getcomposer.org/download ) and [Npm ](https://nodejs.org/en/download )
* Clone the repository: `git clone https://github.com/akaunting/akaunting.git`
* Install dependencies: `composer install ; npm install ; npm run dev`
* Install Akaunting:
2019-11-20 12:26:01 +03:00
2019-11-20 12:27:43 +03:00
```bash
2019-11-21 19:36:35 +03:00
php artisan install --db-name="akaunting" --db-username="root" --db-password="pass" --admin-email="admin@company .com" --admin-password="123456"
2019-11-20 12:27:43 +03:00
```
2020-01-24 16:38:48 +03:00
2020-04-16 18:03:09 +03:00
* Create sample data (optional): `php artisan sample-data:seed`
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
2021-10-27 11:34:16 +03:00
Please review [our security policy ](https://github.com/akaunting/akaunting/security/policy ) on how to report security vulnerabilities.
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 )
2018-02-20 11:54:27 +09:00
2017-09-14 22:21:00 +03:00
## License
Akaunting is released under the [GPLv3 license ](LICENSE.txt ).
