Skip to content

Commit

Permalink
Merge pull request #1 from SolidInvoice/2.3.x
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
hedho committed May 18, 2023
2 parents 7284968 + a771bca commit d1b92c4
Showing 1 changed file with 33 additions and 41 deletions.
74 changes: 33 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,94 +6,86 @@
<br>
</p>

SolidInvoice is a simple open source invoicing application aimed to help small businesses and freelancers manage their day-to-day billing.
It's a feature rich elegant online application to ensure that you can always get paid on time.
SolidInvoice is a sophisticated open-source invoicing application designed to assist small businesses and freelancers in efficiently managing their daily billing operations. With its comprehensive range of features, this elegant online platform ensures that you receive timely payments.

## Features
## Key Features

* Clients and Contacts management
* Create and manage Quotes
* Create and manage Invoices
* Accept payments online
* Tax and discount handling
* RESTful API
* Receive Notifications either via text message, email or through HipChat
* More to come
- Robust clients and contacts management system
- Creation and management of quotes
- Generation and oversight of invoices
- Seamless online payment acceptance
- Effective handling of taxes and discounts
- RESTful API for integration with other systems
- Receive notifications through various channels, including text messages, emails, or HipChat
- Future enhancements planned

## Requirements
## System Requirements

PHP >= 8.1 is required. Use the latest version of PHP for best experience.
SolidInvoice requires PHP version 8.1 or later for optimal performance. It is recommended to use the latest available version of PHP.

## Installation
## Installation Options

### Docker

Docker makes it really easy to get started as quickly as possible in running SolidInvoice.

The docker image is available at [https://hub.docker.com/r/solidinvoice/solidinvoice/](https://hub.docker.com/r/solidinvoice/solidinvoice/) with instructions on how to get started.
Getting started with SolidInvoice is quick and simple using Docker. The Docker image can be found at [https://hub.docker.com/r/solidinvoice/solidinvoice/](https://hub.docker.com/r/solidinvoice/solidinvoice/), along with instructions on how to begin.

### Archived Package

Download the latest release from [https://github.com/SolidInvoice/SolidInvoice/releases](https://github.com/SolidInvoice/SolidInvoice/releases) in either `zip` or `tar.gz` format,
and extract the contents of the archive under your webserver directory.

### For developers
To install SolidInvoice from an archived package, download the latest release in either the `zip` or `tar.gz` format from [https://github.com/SolidInvoice/SolidInvoice/releases](https://github.com/SolidInvoice/SolidInvoice/releases). Extract the contents of the archive into the appropriate directory within your web server.

To install from source, you first need to clone the repository, then you need [composer][1] in order to install all the dependencies.
### Installation for Developers

To clone the repository, issue the following command. Remember to clone the repository to the path you want, that is accessible from your webserver.
If you prefer to install SolidInvoice from the source code, follow these steps:

1. Clone the repository by executing the following command:
```bash
git clone https://github.com/SolidInvoice/SolidInvoice.git
```
Ensure that you choose a destination path accessible from your web server.

Then go into the repository directory

2. Navigate to the cloned repository:
```bash
cd SolidInvoice
```

Now you need to get composer

3. Obtain Composer, a dependency management tool, by running:
```bash
curl -s http://getcomposer.org/installer | php
```

When composer is finished downloading, you can install the required dependencies:

4. Once Composer has finished downloading, install the required dependencies:
```bash
php composer.phar install
```


The final step is to install the Node packages, and compile all the assets

5. Install the necessary Node packages and compile all assets:
```bash
yarn install
yarn dev
```

Now you should have a fully working copy of SolidInvoice.
At this point, SolidInvoice should be fully functional.

If you want to run SolidInvoice in production mode, some additional steps is required:
For production environments, follow these additional steps:

1. Build the project and optimize it for production:
```bash
yarn build
```

## Contributing
2. Deploy the optimized version of SolidInvoice.

See [CONTRIBUTING](CONTRIBUTING.md)
## Contribution Guidelines

## License
For information on contributing to the project, please refer to the [CONTRIBUTING](CONTRIBUTING.md) file.

SolidInvoice is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)
## License

Please see the [LICENSE](LICENSE) file for the full license.
SolidInvoice is licensed under the MIT license, an open-source software license. For detailed information, please consult the [LICENSE](LICENSE) file.

## Sponsor
## Sponsorship

Thank you for supporting the project!
We extend our gratitude to all the sponsors who support this project!

<a class="btn" aria-label="Sponsor @SolidInvoice" href="/sponsors/SolidInvoice?o=esc">
<span>Sponsor @SolidInvoice</span>
Expand Down

0 comments on commit d1b92c4

Please sign in to comment.