{"id":19315454,"url":"https://github.com/fylein/fyle-slack-app","last_synced_at":"2025-04-22T16:32:21.277Z","repository":{"id":37860237,"uuid":"337692101","full_name":"fylein/fyle-slack-app","owner":"fylein","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-10T16:42:23.000Z","size":796,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-15T16:56:59.572Z","etag":null,"topics":["slack","team-integrations"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fylein.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-02-10T10:41:10.000Z","updated_at":"2025-04-10T16:42:28.000Z","dependencies_parsed_at":"2024-08-20T22:03:25.469Z","dependency_job_id":null,"html_url":"https://github.com/fylein/fyle-slack-app","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fylein%2Ffyle-slack-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fylein%2Ffyle-slack-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fylein%2Ffyle-slack-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fylein%2Ffyle-slack-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fylein","download_url":"https://codeload.github.com/fylein/fyle-slack-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250277306,"owners_count":21404026,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["slack","team-integrations"],"created_at":"2024-11-10T01:07:05.188Z","updated_at":"2025-04-22T16:32:20.920Z","avatar_url":"https://github.com/fylein.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# fyle-slack-app #\n\n* Download and install Docker desktop for Mac from [here.](https://www.docker.com/products/docker-desktop)\n\n* Download and install ngrok for Mac from [here](https://ngrok.com/download)\n\n* Once ngrok is installed, run the below command to start ngrok tunnel\n    ```\n    ngrok http 8000\n    ```\n\n* This will spin up a ngrok tunnel with a host name that will proxy slack's API calls to our local server.\n\n* Best to always keep the ngrok tunnel open - can keep a [screen](https://www.geeksforgeeks.org/screen-command-in-linux-with-examples/) session running for this.\n\n\n## Creating new slack app for local development ##\n\n* Ask someone from Slack Team to invite you to the `demo` slack workspace, where the team test their changes.\n\n* Create a new slack app from [here](https://api.slack.com/apps)\n\n* Choose `Create from an app manifest` and ask someone from Slack Team to share an existing manifest file. After copy-pasting the manifest file json data, - \n    \n    * You'll need to replace the existing ngrok urls with the ngrok server url (which you started in your machine) in the manifest of the new app that you created.\n    \n    * You'll also need to change the slack app name to \"Fyle-Dev-\u003cYOUR_NAME\u003e\", just so that you can easily identify the app (assuming multiple devs working on this service).\n\n* After your slack app has been successfully created, you'll need to add these few creds in your `.env` file (which you will create [here](https://github.com/fylein/fyle-slack-app/blob/master/README.md#prerequisites)) -\n\n    * Creds under `App Credentials` present on this slack app's settings page\n    \n    * Your fyle test org TPA creds (`FYLE_CLIENT_ID`, `FYLE_CLIENT_SECRET`)\n\n* Now, all that is left for you, is to install your newly created slack app inside `demo` slack workspace. You can do this by opening this url in your browser.\n    ```\n    https://\u003cYOUR_NGROK_URL\u003e/slack/direct_install\n    ```\n\n* Just FYI - Each developer will be working on their own separate slack app, and not on a common one.\n\n## Local Development ##\n\n## Prerequisites ##\n\n* Create an .env file in the root directory with the following entries:\n\n    ```\n    SECRET_KEY=fakedjangosecretkey\n    FYLE_CLIENT_ID=fakefyleclientid\n    FYLE_CLIENT_SECRET=fakefyleclientsecret\n    FYLE_ACCOUNTS_URL=fakefyleaccounturl\n    FYLE_BRANCHIO_BASE_URI=fakefylebranchiobaseuri\n    SLACK_CLIENT_ID=fakeslackclientid\n    SLACK_CLIENT_SECRET=fakeslackclientsecret\n    SLACK_APP_TOKEN=fakeslackapptoken\n    SLACK_SIGNING_SECRET=fakeslacksigningsecret\n    SLACK_APP_ID=fakeslackappid\n    SLACK_SERVICE_BASE_URL=akeslackservicebaseurl\n    FYLEHQ_SLACK_URL=fakefylehqurl\n    FYLE_SLACK_APP_MIXPANEL_TOKEN=fakemixpaneltoken\n    ALLOWED_HOSTS=fakeallowedhosts\n    DB_NAME=database\n    DB_USER=slack_user\n    DB_PASSWORD=slack12345\n    DB_HOST=database\n    DB_PORT=5432\n    ```\n\n### Bringing up via Docker Compose ###\n\n* For a fresh setup run to build images for services\n    ```\n    docker-compose build\n    ```\n\n* Now run to start services\n    ```\n    docker-compose up\n    ```\n\n* No need to build again to run the services, server will automatically restart if there are changes in codebase.\n\n* If any changes are made in `requirements.txt` you'll need to rebuild images\n    ```\n    docker-compose build\n    \n    docker-compose up\n    ```\n\n* If you want to build and start service in one shot\n\n    ```\n    docker-compose up --build\n    ```\n\n\n### Connecting to PostgreSQL DB container ###\n\n* Ensure that you have services up and running. Then, run the following command to go into interactive-shell of the `database` service container.\n    ```\n    docker-compose exec database bash\n    ```\n\n* And then run the following command to connect to the PostgreSQL DB.\n    ```\n    PGPASSWORD=slack12345 psql -h localhost -U slack_user slack_db\n    ```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffylein%2Ffyle-slack-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffylein%2Ffyle-slack-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffylein%2Ffyle-slack-app/lists"}