{"id":25403138,"url":"https://github.com/sparqone/sparq","last_synced_at":"2025-07-07T06:35:38.065Z","repository":{"id":274368503,"uuid":"922209923","full_name":"sparQone/sparq","owner":"sparQone","description":"sparQ is modular HR/Team Management and general business application platform built with Python and Flask. Features a plugin-based architecture supporting core business apps like HR, task management, document signing, and more. Easy to extend with custom modules and apps.","archived":false,"fork":false,"pushed_at":"2025-02-09T17:10:03.000Z","size":683,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-02-09T17:32:38.589Z","etag":null,"topics":["business","flask-application","hr","plugin-system","python","saas","small-business","sqlalchemy","sqlite"],"latest_commit_sha":null,"homepage":"https://sparqone.github.io/","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/sparQone.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-25T16:00:27.000Z","updated_at":"2025-02-09T17:10:07.000Z","dependencies_parsed_at":"2025-02-09T17:27:10.555Z","dependency_job_id":"1eed9815-2941-4c80-9065-3a82edd5b0d6","html_url":"https://github.com/sparQone/sparq","commit_stats":null,"previous_names":["remarqable/sparqone","remarqable/sparq","sparqone/sparq"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparQone%2Fsparq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparQone%2Fsparq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparQone%2Fsparq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparQone%2Fsparq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sparQone","download_url":"https://codeload.github.com/sparQone/sparq/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239080053,"owners_count":19578107,"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":["business","flask-application","hr","plugin-system","python","saas","small-business","sqlalchemy","sqlite"],"created_at":"2025-02-16T02:28:02.087Z","updated_at":"2025-07-07T06:35:38.058Z","avatar_url":"https://github.com/sparQone.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\nsparQ\n\u003c/h1\u003e\n\n \u003cp align=\"center\"\u003e\u003ca href=\"https://sparqone.github.io\"\u003eProject Home\u003c/a\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/License-Apache_2.0-blue.svg\"\u003e\n\u003c/a\u003e  \n\u003c/p\u003e\n\nsparQ is a modular HR/Team Management and general business application platform built with Python and Flask. It provides a flexible, plugin-based \narchitecture for managing core business operations, allowing businesses to enable or disable modules based on their needs.  \n\n\n\n  \n![sparQ Dashboard](modules/core/views/assets/images/screen1.png)  \n\n[Documentation](https://sparqone.github.io)\n\n## Features\n\n- **Modular System**: Easily extend functionality with independent modules.\n- **Dynamic Module Loading**: Modules are auto-discovered and loaded.\n- **Extensible Plugin Architecture**: Uses `pluggy` for module integration.\n- **Language Support**: Supports multiple languages and user-specific settings.\n- **Built-in Core Modules**:\n  - **Core**: Authentication, module management, and UI framework.\n  - **People**: Employee management, roles, and departments.\n- **Additional Modules**:\n  - **Books**: Accounting and bookkeeping.\n  - **E-Sign**: Digital document signing.\n  - **Tasks**: Task and appointment management.\n  - **Weather \u0026 Clock**: Utility modules (For demonstration purpose)\n- **Modern UI**: HTMX for dynamic updates, Bootstrap styling, and responsive layouts.\n\n\n## Module System\n\nsparQ follows a \"building block\" approach where functionality is divided into independent modules.\n\n[How to write a new module - (Applications and Extensions)](https://github.com/sparqone/sparq/blob/master/docs/Write%20a%20module%20-%20App.md)\n\n\n## Security\n- User authentication and role-based access control.\n- Admin privileges for module management.\n- Secure session management.\n\n## Database Configuration\nsparQ uses PostgreSQL as its database system for all environments (development, testing, and production).\n\n### PostgreSQL Setup\n1. Install PostgreSQL on your server\n2. Create a new database for the application:\n   ```\n   createdb sparq\n   ```\n   \n   For testing, also create a test database:\n   ```\n   createdb sparq_test\n   ```\n\n3. Set environment variables for the database connection:\n   ```\n   export DB_USER=your_username\n   export DB_PASSWORD=your_password\n   export DB_HOST=localhost\n   export DB_PORT=5432\n   export DB_NAME=sparq\n   ```\n   \n   Alternatively, you can set a complete database URL:\n   ```\n   export DATABASE_URL=postgresql://username:password@localhost:5432/sparq\n   ```\n\n4. Install the required PostgreSQL Python driver:\n   ```\n   pip install -r requirements.txt\n   ```\n\n5. Run the application:\n   ```\n   python app.py\n   ```\n\n## Roadmap\n- Additional business modules\n- Enhanced API integration\n- Mobile app support\n- Customization options\n- \n\n## License\nsparQ is released under the Apache-2.0 license\n\n## Contributing\nWe welcome contributions! Please submit issues or pull requests on [GitHub](https://github.com/sparqone/sparq).\n\n## Contact\nFor questions or support, reach out to [asim95@gmail.com](mailto:asim95@gmail.com).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparqone%2Fsparq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparqone%2Fsparq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparqone%2Fsparq/lists"}