https://github.com/fylein/fyle-xero-api

Fyle <> Xero Integration Django Rest Framework API
https://github.com/fylein/fyle-xero-api

team-integrations

Last synced: about 2 months ago
JSON representation

Fyle <> Xero Integration Django Rest Framework API

• Host: GitHub
• URL: https://github.com/fylein/fyle-xero-api
• Owner: fylein
• License: mit
• Created: 2020-10-29T07:36:29.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-23T08:02:54.000Z (8 months ago)
• Last Synced: 2024-05-23T08:57:38.832Z (8 months ago)
• Topics: team-integrations
• Language: Python
• Size: 18.6 MB
• Stars: 3
• Watchers: 4
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Fyle Xero API

Django Rest Framework API for Fyle Xero Integration

### Setup

* Add and update the `fyle_integrations_imports` submodule

    ```bash

    $ git submodule init

    $ git submodule update

    ```

* 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.

* Rename docker-compose.yml.template to docker-compose.yml

    ```

    $ mv docker-compose.yml.template docker-compose.yml

    ```

* Setup environment variables in docker_compose.yml

    ```yaml

    environment:

      SECRET_KEY: thisisthedjangosecretkey

      ALLOWED_HOSTS: "*"

      DEBUG: "False"

      APP_URL: http://localhost:4200

      API_URL: http://localhost:8000/api

      DATABASE_URL: postgres://postgres:postgres@db:5432/xero_db

      FYLE_BASE_URL:

      FYLE_CLIENT_ID:

      FYLE_CLIENT_SECRET:

      FYLE_TOKEN_URI:

      XERO_BASE_URL: https://api.xero.com

      XERO_CLIENT_ID:

      XERO_CLIENT_SECRET:

      XERO_REDIRECT_URI: http://localhost:4200/workspaces/xero/callback

      XERO_TOKEN_URI: https://identity.xero.com/connect/token

   ```

* Build docker images

    ```

    docker-compose build api qcluster

    ```

* Run docker containers

    ```

    docker-compose up -d db api qcluster

    ```

* The database can be accessed by this command, on password prompt type `postgres`

    ```

    docker-compose run db psql -h db -U postgres xero_db

    ```

* To tail the logs a service you can do

    ```

    docker-compose logs -f 

    ```

* To stop the containers

    ```

    docker-compose stop api qcluster

    ```

* To restart any containers - `would usually be needed with qcluster after you make any code changes`

    ```

    docker-compose restart qcluster

    ```

* To run bash inside any container for purpose of debugging do

    ```

    docker-compose exec api /bin/bash

    ```