Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fylein/fyle-qbd-api
API to generate IIF Files for QuickBooks Desktop
https://github.com/fylein/fyle-qbd-api
team-integrations
Last synced: about 2 hours ago
JSON representation
API to generate IIF Files for QuickBooks Desktop
- Host: GitHub
- URL: https://github.com/fylein/fyle-qbd-api
- Owner: fylein
- License: mit
- Created: 2022-11-15T13:28:11.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-27T11:31:05.000Z (10 days ago)
- Last Synced: 2025-01-01T12:39:13.332Z (5 days ago)
- Topics: team-integrations
- Language: Python
- Size: 391 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fyle QuickBooks Desktop API
Django Rest Framework API for Fyle Quickbooks Desktop Integration
### Setup
* Download and install Docker desktop for Mac from [here.](https://www.docker.com/products/docker-desktop)
* If you're using a linux machine, please download docker according to the distrubution you're on.
* Copy docker-compose.yml.template as docker-compose.yml and add required secrets
```
$ cp docker-compose.yml.template docker-compose.yml
```
* Setup environment variables in docker_compose.yml
```yaml
environment:
SECRET_KEY: thisisthedjangosecretkey
ALLOWED_HOSTS: "*"
DEBUG: "False"
FYLE_TOKEN_URI: https://localhost:1234/oauth/token
FYLE_BASE_URL: https://localhost:1234
API_URL: http://localhost:8000/api
FYLE_CLIENT_ID: client_id
FYLE_CLIENT_SECRET: client_secret
DB_NAME: qbd_db
DB_USER: postgres
DB_PASSWORD: postgres
DB_HOST: db
DB_PORT: 5432
```
* Build docker images
```
docker-compose build api worker
```
* Run docker containers
```
docker-compose up -d db api worker
```
* The database can be accessed by this command, on password prompt type `postgres`
```
docker-compose run -e PGPASSWORD=postgres db psql -h db -U postgres qbd_db
```
* To tail the logs of a service you can do
```
docker-compose logs -f
```
* To stop the containers
```
docker-compose stop api worker
```
* To restart any containers - `would usually be needed with qcluster after you make any code changes`
```
docker-compose restart worker
```
* To run bash inside any container for purpose of debugging do
```
docker-compose exec api /bin/bash
```
* If you're a frontend developer you can find the API docs and Postman Collection [here.](https://documenter.getpostman.com/view/8534306/2s8YzRy38t)
### Running Tests
* Run the following commands
1. docker-compose -f docker-compose-pipeline.yml build
2. docker-compose -f docker-compose-pipeline.yml up -d
3. docker-compose -f docker-compose-pipeline.yml exec api pytest tests/