{"id":19367636,"url":"https://github.com/dhouib-mohamed/quoxy","last_synced_at":"2026-02-04T21:35:49.173Z","repository":{"id":232129780,"uuid":"783105970","full_name":"Dhouib-Mohamed/Quoxy","owner":"Dhouib-Mohamed","description":"Quoxy is an API authenticator proxy using Go and SQL, featuring secure token management via Cron jobs and a reverse proxy for authenticated requests.","archived":false,"fork":false,"pushed_at":"2024-08-17T14:00:44.000Z","size":88,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-20T09:49:02.419Z","etag":null,"topics":["api-gateway","api-limiter","api-security","go","proxy","sql","subscription","token-management"],"latest_commit_sha":null,"homepage":"","language":"Go","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/Dhouib-Mohamed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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-04-07T00:37:12.000Z","updated_at":"2024-08-17T14:00:44.000Z","dependencies_parsed_at":"2024-06-14T00:55:48.961Z","dependency_job_id":"2bc2fc8e-7f3c-4a4c-9e86-88ce892b3995","html_url":"https://github.com/Dhouib-Mohamed/Quoxy","commit_stats":null,"previous_names":["dhouib-mohamed/api-authenticator-proxy"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Dhouib-Mohamed/Quoxy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2FQuoxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2FQuoxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2FQuoxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2FQuoxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Dhouib-Mohamed","download_url":"https://codeload.github.com/Dhouib-Mohamed/Quoxy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Dhouib-Mohamed%2FQuoxy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29096422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-04T21:05:08.033Z","status":"ssl_error","status_checked_at":"2026-02-04T21:04:53.031Z","response_time":62,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["api-gateway","api-limiter","api-security","go","proxy","sql","subscription","token-management"],"created_at":"2024-11-10T08:04:01.857Z","updated_at":"2026-02-04T21:35:49.129Z","avatar_url":"https://github.com/Dhouib-Mohamed.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Quoxy: API Authenticator Proxy\n\nQuoxy is a project that implements an API authenticator proxy using Go and SQLite. It features a token subscription system managed via Cron jobs for secure token management and storage, along with a reverse proxy component to redirect authenticated requests to the API. The name \"Quoxy\" is a merge between the words \"quote\" and \"proxy,\" reflecting its role in securely managing and directing API requests.\n## Project Structure\n\n```plaintext\n.\n├── api\n│   └── handler\n│       ├── health.go\n│       ├── index.go\n│       ├── not_found.go\n│       ├── subscription.go\n│       ├── token.go\n│       └── version.go\n├── cmd\n│   └── token-proxy\n├── config.example.yaml\n├── deployment\n│   └── database\n├── internal\n│   ├── database\n│   ├── frequency_cron\n│   ├── models\n│   ├── proxy\n│   ├── tests\n│   └── token_handler\n├── scripts\n│   ├── debug.sh\n│   ├── sql\n│   ├── start.sh\n│   └── test.sh\n├── todo.md\n├── util\n│   ├── config\n│   ├── env\n│   ├── error_handler\n│   ├── log\n│   └── network\n└── version.txt\n```\n\nCertainly! Here's a brief overview of the content in each folder of your project:\n\n1. **api**: Contains handlers for different API endpoints.\n    - **handler**: Contains individual handler files for different endpoints like health checks, subscriptions, tokens, etc.\n\n2. **cmd**: Contains the main application entry point.\n    - **token-proxy**: Contains the main Go file for starting the API authenticator proxy.\n\n3. **config.example.yaml**: An example configuration file. Users can copy this file to `config.yaml` and modify it according to their needs.\n\n4. **deployment**: Contains deployment-related files.\n    - **database**: Contains a Docker Compose file for deploying the SQLite database in a container.\n\n5. **internal**: Contains internal application logic.\n    - **database**: Contains database-related logic and utilities.\n    - **frequency_cron**: Contains logic for managing cron jobs.\n    - **models**: Contains data models for subscriptions and tokens.\n    - **proxy**: Contains logic for the reverse proxy.\n    - **tests**: Contains test files and utilities for testing the application.\n    - **token_handler**: Contains logic for handling tokens.\n\n6. **scripts**: Contains shell scripts for debugging, starting, and testing the application.\n   - **debug.sh**: Shell script for debugging purposes.\n   - **start.sh**: Shell script for starting the application.\n   - **test.sh**: Shell script for running tests.\n\n7. **util**: Contains utility packages for the application.\n   - **config**: Contains utilities for managing configuration settings.\n   - **env**: Contains utilities for managing environment settings.\n   - **error_handler**: Contains utilities for handling errors.\n   - **log**: Contains utilities for logging.\n   - **network**: Contains utilities for managing network settings.\n\n8. **version.txt**: A file containing the version information for the project.\n\nThis structure organizes the project into logical components, making it easier to maintain and extend in the future.\n## Features\n\n- **Token Subscription System:** Utilizes Cron jobs for secure token management and storage.\n- **Reverse Proxy:** Redirects authenticated requests to the API.\n\n## Getting Started\n\n### Prerequisites\n\n- Go (1.22)\n\n### Installation\n\n1. Clone the repository:\n   ```sh\n   git clone https://github.com/yourusername/api-authenticator-proxy.git\n   ```\n2. Navigate to the project directory:\n   ```sh\n   cd api-authenticator-proxy\n   ```\n3. Install dependencies:\n   ```sh\n   go mod download\n   ```\n4. Set up the configuration variables:\n   ```sh\n   cp config.example.yaml config.yaml\n   ```\n5. Set up the environment variables:\n   ```sh\n   cp .env.example .env\n   ```\n\n### Running the Application\n\n1. Start the application:\n   ```sh\n   bash scripts/debug.sh\n   ```\n2. The application will run on the port specified in the `config.yaml` file.\n\n### Running Tests\n\n1. Run the test suite:\n   ```sh\n   bash scripts/test.sh\n   ```\n\n## Deployment\n\nA `docker-compose.yaml` file is included for deploying the supported databases for testing reasons.\n\n1. Navigate to the deployment directory:\n   ```sh\n   cd deployment/database\n   ```\n2. Start the database container:\n   ```sh\n   docker-compose up -d\n   ```\n\n## Contributing\n\nContributions are welcome! Please submit a pull request or open an issue for any enhancements or bugs.\n\n## License\n\nThis project is licensed under the MIT License.\n\n## Contact\n\nFor any questions or inquiries, please contact [mdhouib195@gmail.com].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhouib-mohamed%2Fquoxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdhouib-mohamed%2Fquoxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdhouib-mohamed%2Fquoxy/lists"}