{"id":24324626,"url":"https://github.com/maricastroc/clickmail","last_synced_at":"2026-04-13T03:06:47.260Z","repository":{"id":271787321,"uuid":"912966419","full_name":"maricastroc/clickmail","owner":"maricastroc","description":"Mail Tracking Service built with PHP / Laravel and React.js","archived":false,"fork":false,"pushed_at":"2025-02-12T20:15:35.000Z","size":445,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-12T21:22:55.796Z","etag":null,"topics":["laravel","php","reactjs","sqlite","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/maricastroc.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":"2025-01-06T18:57:02.000Z","updated_at":"2025-02-12T20:15:38.000Z","dependencies_parsed_at":"2025-01-28T14:31:59.886Z","dependency_job_id":"51b789f4-7483-447a-9886-164ab51214f8","html_url":"https://github.com/maricastroc/clickmail","commit_stats":null,"previous_names":["maricastroc/clickmail"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maricastroc%2Fclickmail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maricastroc%2Fclickmail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maricastroc%2Fclickmail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/maricastroc%2Fclickmail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/maricastroc","download_url":"https://codeload.github.com/maricastroc/clickmail/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242973962,"owners_count":20215245,"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":["laravel","php","reactjs","sqlite","tailwindcss","typescript"],"created_at":"2025-01-17T19:57:25.359Z","updated_at":"2026-04-13T03:06:47.214Z","avatar_url":"https://github.com/maricastroc.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n![image](https://github.com/user-attachments/assets/af9d3e26-b8b3-47df-a210-7d574444309e)\n\n\n# Mail Tracking Service System\n\nThis is an email tracking service that allows you to monitor opens and clicks on email campaigns. The application allows you to create and manage campaigns, send emails to subscriber lists, track interactions with templates, and view campaign statistics. The front-end is built with React.js, and the back-end is powered by Laravel and PHP.\n\n## 📋 Features\n\n- Campaign Management: Create, view, and delete email campaigns.\n- Email Lists: Create and manage email lists of subscribers.\n- Subscribers: Manage subscribers, including the ability to add, edit, and remove them.\n- Email Tracking: Track email opens and click activity.\n- Email Templates: Create and customize email templates for campaigns.\n- Campaign Statistics: View open and click rates for each campaign.\n\n## 🛠 Technologies Used\n\n- Laravel (PHP): Backend to manage the system, user authentication, and business logic.\n- React.js: Frontend for user interaction.\n- SQLite: Database used to store data locally.\n- Tailwind CSS: CSS framework for styling.\n- Inertia.js: Framework for integration between Laravel backend and React frontend.\n- SQLite: Relational database for storing campaign data, email lists, and subscriber information.\n- Mailpit: Used to simulate email sending during development.\n\n## ⚙️ Key Concepts\n\n- Authentication Middleware: Ensures only authorized users can access campaign data.\n- Factories \u0026 Seeders: Used for generating and seeding test data (campaigns, subscribers).\n- Controllers: Handle campaign logic and interactions.\n- Models: Represent database tables and relationships (e.g., Campaign, Subscriber).\n- Queues \u0026 Jobs: Queue background tasks like sending emails and tracking events to improve performance.\n\n## 🔧 How to Run the Project\n\n### Prerequisites\nBefore running the project, you need to have the following dependencies installed:\n\n- PHP (version 8.0 or higher)\n- Composer (for managing PHP dependencies)\n- Node.js (for running React)\n- NPM (package manager for Node.js)\n\n### Steps to Run the Project\n\n\u003e Clone the repository:\n\n```bash\ngit clone https://github.com/maricastroc/sitemark\n```\n\n\u003e Install PHP dependencies:\n\n```bash\ncomposer install\n```\n\n\u003e Configure environment variables:\n\n```bash\ncp .env.example .env\n```\n\n\u003e Configure the environment variables in the .env file, especially the ones related to the database (SQLite):\n\n```bash\nDB_CONNECTION=sqlite\nDB_DATABASE=/path/to/your/database/database.sqlite\n```\n\n\u003e Generate the Laravel application key:\n\n```bash\nphp artisan key:generate\n```\n\n\u003e Install Node.js dependencies:\n\n```bash\nnpm install\n```\n\n\u003e Build the front-end files:\n\n```bash\nnpm run build\n```\n\n\u003e Start the server for the Laravel backend::\n\n```bash\nphp artisan serve\n```\n\n\u003e Start the server for the React front-end:\n```bash\nnpm run dev\n```\n\n\u003e ⏩ The React server will be available at [http://localhost:3000](http://localhost:3000).\n\nIf you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.\n\n## License\n\nThe Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaricastroc%2Fclickmail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmaricastroc%2Fclickmail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmaricastroc%2Fclickmail/lists"}