v2 first commit
This commit is contained in:
denisdulici
74
README.md
74
README.md
@ -1,8 +1,8 @@
|
||||
# Akaunting™
|
||||
|
||||
  [](https://crowdin.com/project/akaunting)  [](#backers) [](#sponsors)
|
||||
  [](https://crowdin.com/project/akaunting) 
|
||||
|
||||
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, Bootstrap, jQuery, RESTful API etc. Thanks to its modular structure, Akaunting provides an awesome App Store for users and developers.
|
||||
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.
|
||||
|
||||
* [Home](https://akaunting.com) - The house of Akaunting
|
||||
* [Blog](https://akaunting.com/blog) - Get the latest news
|
||||
@ -12,51 +12,25 @@ Akaunting is a free, open source and online accounting software designed for sma
|
||||
|
||||
## Requirements
|
||||
|
||||
* PHP 5.6.4 or higher
|
||||
* PHP 7.2 or higher
|
||||
* Database (eg: MySQL, PostgreSQL, SQLite)
|
||||
* Web Server (eg: Apache, Nginx, IIS)
|
||||
* [Other libraries](https://akaunting.com/docs/requirements)
|
||||
|
||||
## Framework
|
||||
|
||||
Akaunting uses [Laravel](http://laravel.com), the best existing PHP framework, as the foundation framework and [Modules](https://nwidart.com/laravel-modules) package for Apps.
|
||||
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.
|
||||
|
||||
## Installation
|
||||
|
||||
* 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)
|
||||
|
||||
## Docker
|
||||
|
||||
It is possible to containerise Akaunting using the [`docker-compose`](docker-compose.yml) file. Here are a few commands:
|
||||
|
||||
```
|
||||
# Build the app
|
||||
docker build -t akaunting .
|
||||
|
||||
# Run the app
|
||||
docker-compose up -d
|
||||
|
||||
# Make sure you the dependencies are installed
|
||||
docker-compose exec web composer install
|
||||
|
||||
# Stream logs
|
||||
docker-compose logs -f web
|
||||
|
||||
# Access the container
|
||||
docker-compose exec web /bin/sh
|
||||
|
||||
# Stop & Delete everything
|
||||
docker-compose down -v
|
||||
```
|
||||
* 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)
|
||||
|
||||
## Contributing
|
||||
|
||||
Fork the repository, make the code changes then submit a pull request.
|
||||
|
||||
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.
|
||||
@ -77,35 +51,19 @@ If you discover any security related issues, please email security@akaunting.com
|
||||
|
||||
## Credits
|
||||
|
||||
- [Denis Duliçi](https://github.com/denisdulici)
|
||||
- [Cüneyt Şentürk](https://github.com/cuneytsenturk)
|
||||
- [All Contributors](../../contributors)
|
||||
* [Denis Duliçi](https://github.com/denisdulici)
|
||||
* [Cüneyt Şentürk](https://github.com/cuneytsenturk)
|
||||
* [All Contributors](../../contributors)
|
||||
|
||||
## Contributors
|
||||
## Partners
|
||||
|
||||
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
|
||||
[](../../contributors)
|
||||
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.
|
||||
|
||||
## Backers
|
||||
|
||||
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/akaunting#backer)]
|
||||
|
||||
[](https://opencollective.com/akaunting#backers)
|
||||
* [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
|
||||
|
||||
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/akaunting#sponsor)]
|
||||
|
||||
[](https://opencollective.com/akaunting/sponsor/0/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/1/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/2/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/3/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/4/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/5/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/6/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/7/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/8/website)
|
||||
[](https://opencollective.com/akaunting/sponsor/9/website)
|
||||
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.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
Reference in New Issue
Block a user