Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/c-delouvencourt/beam-invoice

Open Source Invoicing App for Freelancers & Auto-entrepreneur. 💲📑
https://github.com/c-delouvencourt/beam-invoice

auto-entrepreneur beam freelance freelancers invoice invoicing webpack

Last synced: 4 days ago
JSON representation

Open Source Invoicing App for Freelancers & Auto-entrepreneur. 💲📑

Awesome Lists containing this project

README

        

**Open Source Invoicing App for Freelancers & Auto-entrepreneur. 💲📑**


[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/clementdlc)

![Screenshot](https://i.imgur.com/1qDPHN4.png)
___

### :rocket: Features

|Features|... |
|-------------------------------|-----------------------------|
|`Invoice` |***Planned***|
|`Estimates` |***Planned***|
|`Taxes`|***Planned***|
|`Contracts`|***Planned***|
___

### :cloud: Installation

#### Requirements:
```
NodeJS
MySQL or PostgreSQL server
```

**Only one step :**
```shell
npm run-script lift
```
### :pencil: Production start

Webpack builds the bundle files on `postinstall` and Beam is lifted the same way it's always lifted in production:

```shell
npm run dist
```
___

### :computer: Development

There are multiple ways to run the project in development as sails and webpack-dev-server run independently. The easiest way is to use [Foreman](https://github.com/theforeman/foreman) (`npm install -g foreman`) and run:

```shell
nf start
```

This will start all processes listed in the `Procfile`.

The alternative is to manually run each process in separate terminal windows.

To view Beam app, go to `http://localhost:3000` in your browser.
___

### :round_pushpin: Translate
Help us translate or suggest changes to existing languages if you find any mistakes.

**Here's the localization platform :** (https://poeditor.com/join/project/zjrG5XDl4i).

---

### :mag_right: Credits

Beam is a product of [NocturneLab](https://github.com/PHClement)

**Special thanks to:**

- *Zohir Belhaouzia* for the Italian translation.
- *Your name here ?*