{"id":23703365,"url":"https://github.com/scholarx-assesment/notification-service","last_synced_at":"2026-05-08T05:32:44.401Z","repository":{"id":268682785,"uuid":"903027351","full_name":"scholarX-Assesment/notification-service","owner":"scholarX-Assesment","description":"Notification service to deliver notifications to related parties about the operations in the institute","archived":false,"fork":false,"pushed_at":"2025-01-13T06:15:19.000Z","size":18,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-22T23:11:31.266Z","etag":null,"topics":["brevo-api","docker","fastapi","github-actions","microservice"],"latest_commit_sha":null,"homepage":"","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/scholarX-Assesment.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,"zenodo":null}},"created_at":"2024-12-13T19:17:19.000Z","updated_at":"2025-01-13T06:15:23.000Z","dependencies_parsed_at":"2024-12-18T09:42:27.208Z","dependency_job_id":"c55a1f84-9f2f-4da1-9366-ebea0dc16fd0","html_url":"https://github.com/scholarX-Assesment/notification-service","commit_stats":null,"previous_names":["scholarx-assesment/notification-service"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/scholarX-Assesment/notification-service","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scholarX-Assesment%2Fnotification-service","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scholarX-Assesment%2Fnotification-service/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scholarX-Assesment%2Fnotification-service/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scholarX-Assesment%2Fnotification-service/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scholarX-Assesment","download_url":"https://codeload.github.com/scholarX-Assesment/notification-service/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scholarX-Assesment%2Fnotification-service/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259529817,"owners_count":22872082,"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":["brevo-api","docker","fastapi","github-actions","microservice"],"created_at":"2024-12-30T13:01:33.522Z","updated_at":"2026-05-08T05:32:44.372Z","avatar_url":"https://github.com/scholarX-Assesment.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Email Notification Service\n\n## Overview\nThe Email Notification Service is a FastAPI-based service that provides endpoints to send individual and bulk emails. It is designed to be simple and easy to integrate with other services.\n\n## Features\n- Send individual emails\n- Send bulk emails\n- Easy to set up and use\n\n## Requirements\n- Python 3.7+\n- FastAPI\n- SQLAlchemy\n- A configured SMTP server for sending emails\n\n## Setup\n\n### 1. Clone the repository\n```bash\ngit clone https://github.com/yourusername/notification-service.git\ncd notification-service\n```\n\n### 2. Create a virtual environment and activate it\n```bash\npython -m venv venv\nsource venv/bin/activate  # On Windows use `venv\\Scripts\\activate`\n```\n\n### 3. Install the dependencies\n```bash\npip install -r requirements.txt\n```\n\n### 4. Configure the database\nUpdate the `DATABASE_URL` in the `app/database.py` file to point to your database.\n\n### 5. Configure the SMTP server\nUpdate the SMTP settings in the `app/email.py` file with your SMTP server details.\n\n### 6. Run the application\n```bash\nuvicorn main:app --reload\n```\n\nThe service will be available at `http://127.0.0.1:8000`.\nAPI docs http://127.0.0.1:8000/docs in swagger UI\n\n## API Documentation\nFor detailed API documentation, refer to the [API-docs.md](./API-docs.md) file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscholarx-assesment%2Fnotification-service","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscholarx-assesment%2Fnotification-service","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscholarx-assesment%2Fnotification-service/lists"}