{"id":24375092,"url":"https://github.com/a-r007/flowchartmaker","last_synced_at":"2026-03-15T12:23:41.379Z","repository":{"id":269258075,"uuid":"906875504","full_name":"A-R007/FlowchartMaker","owner":"A-R007","description":"Flask Groq Flowchart Generator is a web app that converts natural language descriptions into customizable flowcharts in Graphviz DOT format. It features color-coded nodes for different process stages and ensures easy visualization with valid syntax and clear layouts.","archived":false,"fork":false,"pushed_at":"2024-12-27T04:32:35.000Z","size":162,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-12T12:22:58.607Z","etag":null,"topics":["flask-application","flowchart-diagrams","groq-api","render"],"latest_commit_sha":null,"homepage":"https://flowchartmaker.onrender.com/","language":"HTML","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/A-R007.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-12-22T07:02:47.000Z","updated_at":"2024-12-27T04:32:38.000Z","dependencies_parsed_at":null,"dependency_job_id":"83d051d3-1cec-485c-bf64-6e5de6e3d74f","html_url":"https://github.com/A-R007/FlowchartMaker","commit_stats":null,"previous_names":["a-r007/flowchartmaker"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/A-R007/FlowchartMaker","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/A-R007%2FFlowchartMaker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/A-R007%2FFlowchartMaker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/A-R007%2FFlowchartMaker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/A-R007%2FFlowchartMaker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/A-R007","download_url":"https://codeload.github.com/A-R007/FlowchartMaker/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/A-R007%2FFlowchartMaker/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28003415,"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-12-24T02:00:07.193Z","response_time":83,"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":["flask-application","flowchart-diagrams","groq-api","render"],"created_at":"2025-01-19T05:53:10.848Z","updated_at":"2025-12-24T13:40:53.928Z","avatar_url":"https://github.com/A-R007.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flask Groq Flowchart Generator\n\nThis is a Flask-based web application that integrates with the **Groq API** to generate flowcharts in **Graphviz DOT** format based on user-provided descriptions. The app allows users to visualize processes as flowcharts with distinct color schemes and node types for better readability.\n\n## Features\n\n- **Flowchart Generation**: Generate flowcharts in Graphviz DOT format based on natural language descriptions.\n- Color-coded Nodes:\n  - **Start/End Nodes**: Light blue, round-shaped nodes representing the start or end of a process.\n  - **Process Nodes**: Green, rectangular nodes with slightly rounded corners representing actions or tasks.\n  - **Decision Nodes**: Red, diamond-shaped nodes representing decision points in the process flow.\n- **Node Labeling**: Each node is labeled with descriptive text explaining its role.\n- **Customizable Flow Layout**: Flowcharts can be organized either vertically or horizontally with clear, readable transitions.\n- **Validation**: The app extracts and validates the DOT definition to ensure correct syntax.\n\n## Prerequisites\n\nBefore running the app, ensure the following are installed:\n\n- Python 3.11 or later\n- `pip` (Python's package installer)\n\n## Setup Instructions\n\n### 1. Clone the Repository\n\nClone the project to your local machine using the following command:\n\n```bash\ngit clone \u003crepo-link\u003e\ncd \u003cyour-folder\u003e\n```\n\n### 2. Create and Activate a Virtual Environment\n\nCreate and activate a virtual environment to isolate the dependencies:\n\n```bash\npython -m venv venv\n# On Windows\nvenv\\Scripts\\activate\n# On macOS/Linux\nsource venv/bin/activate\n```\n\n### 3. Install Dependencies\n\nInstall the required dependencies using `pip`:\n\n```bash\npip install -r requirements.txt\n```\n\n### 4. Set Up Environment Variables\n\nCreate a `.env` file in the root of your project and add your **Groq API Key**:\n\n```ini\nGROQ_API_KEY=your_api_key_here\n```\n\nYou can obtain an API key from the [Groq website](https://groq.com/).\n\n### 5. Run the Application\n\nStart the Flask application locally:\n\n```bash\npython app.py\n```\n\nThe app will be available at `http://127.0.0.1:5000/` in your browser.\n\n### 6. Deploy on Render (Optional)\n\nTo deploy the app on Render:\n\n1. Push your code to GitHub.\n2. Sign in to [Render](https://render.com) and create a new web service.\n3. Connect the service to your GitHub repository.\n4. Add the following to your `Procfile` to specify how to start the app:\n\n    ```plaintext\n    web: gunicorn app:app\n    ```\n\n5. After deployment, the app will be available at a Render-generated domain.\n\n## Usage\n\n1. **Home Page**: Visit the home page (`/`) to access the web interface.\n2. **Generate Flowchart**: Send a POST request to the `/generate_flowchart` endpoint with a JSON body containing a `description` field. The description should be a text representation of the process you want to visualize in the flowchart.\n   \n   Example request:\n   \n   ```json\n   {\n     \"description\": \"A process that starts, performs a task, and ends with a decision.\"\n   }\n   ```\n\n3. **Flowchart Response**: The response will be a JSON object containing the flowchart in DOT format. Use Graphviz tools to render the flowchart visually.\n\n### Example Response:\n\n```json\n{\n  \"dot_definition\": \"digraph G { ... }\"\n}\n```\n\n### Error Handling:\n\n- **Missing Description**: If no description is provided in the request, the server will respond with a `400 Bad Request` error.\n  \n  Example:\n\n  ```json\n  {\n    \"error\": \"No description provided\"\n  }\n  ```\n\n- **Flowchart Generation Failure**: If the flowchart generation fails, the server will respond with a `500 Internal Server Error`.\n  \n  Example:\n\n  ```json\n  {\n    \"error\": \"Failed to generate flowchart\"\n  }\n  ```\n\n## Troubleshooting\n\n- **Bad Gateway Error**: Ensure that the Flask app is running correctly and check your deployment settings.\n- **Invalid API Key**: If the flowchart is not being generated, ensure that you have set your **GROQ_API_KEY** correctly in the `.env` file.\n\n## Contributing\n\nContributions are welcome! Please fork the repository, make your changes, and submit a pull request.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-r007%2Fflowchartmaker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fa-r007%2Fflowchartmaker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fa-r007%2Fflowchartmaker/lists"}