{"id":31767906,"url":"https://github.com/webdevtodayjason/changereq","last_synced_at":"2025-10-10T01:48:53.738Z","repository":{"id":257014415,"uuid":"856596809","full_name":"webdevtodayjason/changereq","owner":"webdevtodayjason","description":"Change Request Slack Bot","archived":false,"fork":false,"pushed_at":"2024-09-13T19:33:15.000Z","size":14,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-06T01:30:30.066Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/webdevtodayjason.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-09-12T21:14:55.000Z","updated_at":"2024-09-13T19:20:21.000Z","dependencies_parsed_at":"2024-09-14T10:40:32.863Z","dependency_job_id":null,"html_url":"https://github.com/webdevtodayjason/changereq","commit_stats":null,"previous_names":["webdevtodayjason/changereq"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/webdevtodayjason/changereq","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdevtodayjason%2Fchangereq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdevtodayjason%2Fchangereq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdevtodayjason%2Fchangereq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdevtodayjason%2Fchangereq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/webdevtodayjason","download_url":"https://codeload.github.com/webdevtodayjason/changereq/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/webdevtodayjason%2Fchangereq/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279002400,"owners_count":26083375,"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","status":"online","status_checked_at":"2025-10-09T02:00:07.460Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-10-10T01:48:44.083Z","updated_at":"2025-10-10T01:48:53.732Z","avatar_url":"https://github.com/webdevtodayjason.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ChangeReq\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Features](#features)\n- [Technologies Used](#technologies-used)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n- [Configuration](#configuration)\n  - [Google API Setup](https://webdevtodayjason.github.io/changereq/google_api_setup.html)\n  - [Slack API Setup](https://webdevtodayjason.github.io/changereq/slack_api_setup.html)\n- [Running the Application Locally](#running-the-application-locally)\n- [Deployment with Railway](#deployment-with-railway)\n- [Endpoints](#endpoints)\n- [Logging](#logging)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Overview\n\n**ChangeReq** is a **Flask** web application integrated with **Slack** and **Google Sheets**. It allows users to submit change requests via Slack, which are then recorded in a Google Sheet and notified in a designated Slack channel. The application is configured for production using **Gunicorn** and is deployed on **Railway**.\n\n## Features\n\n- **Slack Integration:** Receive slash commands and interact with users through Slack modals.\n- **Google Sheets Integration:** Store and manage change requests in a Google Sheet.\n- **Health Check Endpoint:** Monitor the application's health status.\n- **Logging:** Comprehensive logging for monitoring and debugging.\n- **Production-Ready Deployment:** Configured with Gunicorn for handling production workloads.\n\n## Technologies Used\n\n- **Python 3.8+**\n- **Flask**\n- **Gunicorn**\n- **Slack SDK**\n- **Google Sheets API (gspread)**\n- **Railway**\n\n## Prerequisites\n\nBefore setting up the project, ensure you have the following installed:\n\n- **Python 3.8+**\n- **pip** (Python package manager)\n- **Git**\n- **Railway Account** (Sign up at [Railway](https://railway.app/))\n\n## Installation\n\nFollow these steps to set up the project locally:\n\n1. **Clone the Repository:**\n\n   ```bash\n   git clone https://github.com/webdevtodayjason/changereq.git\n   cd changereq\n   ```\n\n2. **Create a Virtual Environment:**\n\n   ```bash\n   conda create -n changereq python=3.12\n   conda activate changereq\n   ```\n\n3. **Install Dependencies:**\n\n   ```bash\n   pip install -r requirements.txt\n   ```\n## Configuration\nEnvironment Variables\nThe application relies on several environment variables for configuration. Ensure these are set before running the application.\n\nSLACK_BOT_TOKEN: Your Slack Bot Token.\nGOOGLE_CREDENTIALS_JSON: JSON string of your Google service account credentials.\nPORT: (Optional) Port number for the application to listen on. Defaults to 8080.\n\n### Setting Environment Variables Locally\nCreate a .env file in the root directory of your project and add the following:\n\n4. **Set Up Environment Variables:**\n\n   - Create a `.env` file in the root directory.\n   - Add the following environment variables:\n\n   ```bash\n   SLACK_BOT_TOKEN=\u003cyour_slack_bot_token\u003e\n   GOOGLE_CREDENTIALS_JSON=\u003cyour_google_credentials_json\u003e\n   ```\n\n## Running the Application Locally\nTo run the application locally, use the following command:\n\n```bash\npython app.py\n```\n\n## Deployment with Railway\n\n1. **Create a Railway Account:**\n\n   - Sign up at [Railway](https://railway.app/).\n\n2. **Create a New Project:**\n\n   - Click on the \"New Project\" button.\n   - Select \"GitHub\" as the provider and connect your GitHub account.\n   - Find the repository you want to deploy and click on \"Connect\".\n\n3. **Configure Environment Variables:**\n\n   - Go to the \"Variables\" tab.\n   - Add the following variables:\n\n   ```bash\n   SLACK_BOT_TOKEN=\u003cyour_slack_bot_token\u003e\n   GOOGLE_CREDENTIALS_JSON=\u003cyour_google_credentials_json\u003e\n   PORT=\u003cyour_port_number\u003e\n   ```\n\n4. **Deploy the Application:**\n\n   - Click on the \"Deploy\" button.\n   - Railway will build and deploy your application.\n\n5. **Access the Application:**\n\n   - Once deployed, you can access your application at the URL provided by Railway.\n\n## Endpoints\n\n### Health Check\n\nTo check the health status of the application, send a GET request to:\n\n```bash\nhttp://\u003cyour_railway_url\u003e/health\n```\n\n### Slack Slash Command\n\nTo submit a change request, send a POST request to:\n\n```bash\nhttp://\u003cyour_railway_url\u003e/changereq\n```\n\n### Slack Modal Submission\n\nTo submit a change request via Slack modal, send a POST request to:\n\n```bash\nhttp://\u003cyour_railway_url\u003e/changereq\n```\n\n### Slack Modal Submission\n\nTo submit a change request via Slack modal, send a POST request to:\n\n```bash\nhttp://\u003cyour_railway_url\u003e/changereq\n```\n\n## Logging\n\nTo submit a change request via Slack modal, send a POST request to:\n\n```bash\nhttp://\u003cyour_railway_url\u003e/changereq\n```\n    ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdevtodayjason%2Fchangereq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwebdevtodayjason%2Fchangereq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwebdevtodayjason%2Fchangereq/lists"}