https://github.com/fylein/fyle-backup-app

Multi-tenant self serve application to take backup of Fyle data
https://github.com/fylein/fyle-backup-app

Last synced: about 2 months ago
JSON representation

Multi-tenant self serve application to take backup of Fyle data

• Host: GitHub
• URL: https://github.com/fylein/fyle-backup-app
• Owner: fylein
• License: mit
• Created: 2020-03-12T15:16:25.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-16T03:53:12.000Z (about 2 years ago)
• Last Synced: 2023-03-02T20:45:53.289Z (almost 2 years ago)
• Language: Python
• Size: 1.25 MB
• Stars: 0
• Watchers: 14
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# fyle-backup-app

Multi-tenant self serve application to take backup of Fyle data

### Development setup

1. Fyle App registration (get your client_id and client_secret here)

    1. Login to [Fyle](https://app.fyle.in)

    2. Goto settings and click on Developers

    3. Click on create new app, enter the details and select type as OAuth 2.0

    4. For Redirect URI enter 

        1. 'http://localhost:8000/main/callback/' for development

        2. 'https://your_domain/main/callback/' for production

        3. 'http://localhost:8000/accounts/fyle/login/callback/' for development

        4. 'https://your_domain/accounts/fyle/login/callback/' for production

    5. Note down the client_secret and client_id

2. Install the project dependencies by running `pip install -r requirements.txt`in a python environment of your choice

    1. If you face an error related to mysql_config follow the steps in [this](https://stackoverflow.com/questions/7475223/mysql-config-not-found-when-installing-mysqldb-python-interface) article

3. Rename the file ```.setup_template.sh``` to ```.setup.sh``` and customize it accordingly

4. Run ```source .setup.sh``` to export the environment variables

5. Run ```python manage.py migrate``` to populate your database

6. Run ```python manage.py createsuperuser``` and follow the instructions to create a superuser

7. Open django-admin and create a new record under Social Applications. Select Fyle as provider and enter your client_secret and client_id. Add our site to the Chosen sites on the bottom.

8. Create a log file at ```/var/log/fyle/fyle_backup.log```

9. Run ```python manage.py runserver``` to start the server on localhost

10. You might want to comment out the FyleJobs section (```apps/backups/views.py```) during development

11. Run ```python manage.py collectstatic``` to collect static files to static_root directory, before deploying onto a Prod server

Visit [http://localhost:8000](http://localhost:8000) to access the application