https://github.com/codex-team/codex-accounting
Microservice for accounting
https://github.com/codex-team/codex-accounting
Last synced: 5 months ago
JSON representation
Microservice for accounting
- Host: GitHub
- URL: https://github.com/codex-team/codex-accounting
- Owner: codex-team
- License: apache-2.0
- Created: 2020-06-23T18:08:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-03T20:01:04.000Z (7 months ago)
- Last Synced: 2024-11-08T07:46:28.882Z (7 months ago)
- Language: TypeScript
- Size: 1.25 MB
- Stars: 1
- Watchers: 7
- Forks: 1
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CodeX Accounting
Microservice for accounting📋
## How to run accounting service
1. Copy and rename file `.env.sample` to `.env`.
2. Generate two UUIDv4 IDs for cashbook and revenue accounts. You can use online generators (see https://www.uuidgenerator.net/version4).
3. Add information about cashbook and revenue to `.env` file:
Example:
```dotenv
# Accounting Cashbook account identifier
CASHBOOK_ACCOUNT_ID=#Your UUIDv4 cashbook account ID
CASHBOOK_ACCOUNT_NAME="Hawk Cashbook account"
# Accounting Revenue account identifier
REVENUE_ACCOUNT_ID=#Your UUIDv4 revenue account ID
REVENUE_ACCOUNT_NAME="Hawk Revenue account"
```
4. Install dependencies by `yarn install`.
5. Run accounting service by `yarn dev` or `yarn docker:up` commands.
6. Run MongoDB migrations by `yarn migrate:up`.
You will see a message like this:
```text
yarn run v1.21.1
$ migrate-mongo up
MIGRATED UP: 20200724163828-base-accounts.js
Done in 1.26s.
```
🎉Now you can use accounting service in your projects🎉