Files
serverless-invoices/README.md
2023-03-07 11:27:38 +02:00

106 lines
3.5 KiB
Markdown

<a href="https://www.producthunt.com/posts/serverless-invoices?utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-serverless-invoices" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=287626&theme=light&period=daily" alt="Serverless Invoices - Open source, serverless invoice generator | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
# Serverless Invoices by Moku
Serverless Invoices is a free invoicing tool for freelancers and small businesses.
It is open-source and easily extendable. You can use it as a starter kit for more complex systems. Implement your own features, localization, styling
or integrate with various other systems and API-s.
Run it locally or host it yourself.
You can always use the latest free version at [invoices.mokuapp.io](https://invoices.mokuapp.io)
Built with [Vue.js](https://vuejs.org/) and [Bootstrap](https://getbootstrap.com/)
## Features
- Truly serverless - data stored in your browser only, no network requests
- No hosting required - works locally
- Invoices
- Create & manage invoices
- Track invoices by status and due date
- Multiple custom taxes
- Print to PDF
- Customizable logo and template, CSS
- Bank accounts
- Clients
- Create & manage clients
- Custom fields
- Company details
- Edit default company details
- Custom fields
- Default taxes
- Export & import json data
- Dark and light mode!
- Multilingual
- PWA support
- Ready-to-go backend adapters
- [Browser Storage](https://invoices.mokuapp.io)
- [Wordpress](https://wordpress.org/plugins/beautiful-custom-invoices/)
- Woocommerce (coming soon)
- Google Drive (coming soon)
- Custom HTTP API
## Project setup
Requires `node 16.18`
```
npm install
```
### Compiles and hot-reloads for development
```
npm run serve
```
### Compiles and minifies for production
```
npm run build
```
### Lints and fixes files
```
npm run lint
```
## Run with Docker
It is necessary to install Docker before running the following commands.
```
git clone https://github.com/mokuappio/serverless-invoices.git
cd serverless-invoices.git
docker build . -t mokuappio/serverless-invoices
docker run -p 80:8080 -d --rm mokuappio/serverless-invoices
```
It is possible to add an alias in your .bashrc/.zshrc file to launch the app on the fly.
```
echo "alias serverless-invoices='docker run -p 80:8080 -d --rm mokuappio/serverless-invoices'" >> ~/.zshrc
source ~/.zshrc
serverless-invoices
```
## Topics
- invoices management
- invoicing solution
- invoice maker
- invoice generator
## Affiliates and sponsors
<a href="https://www.zone.ee/en/" target="_blank"><img src="https://www.zone.ee/wp-content/themes/zone-theme/img/zone_ee.svg" alt="Zone - Domains and web hosting" width="150"/></a>
**ZONE** offers fast and secure web hosting, spam free email, cheap domains and quality support.
Get **50%** off your first year with the code **ELEVATE**
- [Get your web, email and domain](https://my.zone.eu/en/domain-search#/?campaign=ELEVATE)
- Already have a domain? [Get only web and email](https://my.zone.eu/en/zwebadmin/webhosting/order?campaign=ELEVATE)
<a href="https://mokuapp.io/" target="_blank"><img src="https://user-images.githubusercontent.com/5262399/170223530-0634d5c4-56d8-425e-846c-09f352f7b00c.png" alt="Moku - Time tracking, task management and automated invoicing" width="150"/></a>
**MOKU** offers simple time tracking, task management and automated invoicing for ambitious dev teams and freelancers.
- [Get your free trial](https://mokuapp.io/)