Project Awesome project awesome

Akaunting

A free and online accounting software for small businesses and freelancers based on Laravel and VueJS.

Package 9.8k stars GitHub

# Akaunting™

Release Downloads Translations Tests

Online accounting software designed for small businesses and freelancers. Akaunting 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.

Requirements

  • PHP 8.1 or higher
  • Database (e.g.: MariaDB, MySQL, PostgreSQL, SQLite)
  • Web Server (eg: Apache, Nginx, IIS)
  • Other libraries

Framework

Akaunting uses Laravel, the best existing PHP framework, as the foundation framework and Module package for Apps.

Installation

Before installing Akaunting, make sure your environment has the required dependencies installed:

  • PHP 8.1 or higher with the required PHP extensions
  • Composer
  • Node.js and npm
  • Git
  • A supported database server, such as MariaDB, MySQL, PostgreSQL, or SQLite
  • A web server, such as Apache, Nginx, or IIS
  • Build tools required by some npm packages, such as build-essential on Debian/Ubuntu systems

For the full list of PHP extensions and server requirements, see the on-premise requirements.

Then install Akaunting:

  • Clone the repository: git clone https://github.com/akaunting/akaunting.git
  • Install dependencies: composer install ; npm install ; npm run dev
  • Install Akaunting:
php artisan install --db-name="akaunting" --db-username="root" --db-password="pass" --admin-email="admin@company.com" --admin-password="123456"
  • Create sample data (optional): php artisan sample-data:seed

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.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Translation

If you'd like to contribute translations, please check out our Crowdin project.

Changelog

Please see Releases for more information about what has changed recently.

Security

Please review our security policy on how to report security vulnerabilities.

Credits

License

Akaunting is released under the BSL license.

Back to Vue.js