Warning
BETA RELEASE NOTICE WorkSphere is currently in active BETA development. Features are subject to change, and you may encounter bugs or instability. NOT RECOMMENDED FOR PRODUCTION USE without extensive testing.
WorkSphere is a comprehensive enterprise Single Page Application (SPA) built on Laravel 12 and Vue 3. It functions as a "Super App," integrating multiple core business modules into a unified, real-time interface.
- Framework: Laravel 12.x
- Real-time: Laravel Reverb (WebSocket)
- Database: MySQL 8.x + Redis (Cache/Queue)
- Search: Database (via Laravel Scout)
- Authentication: Laravel Fortify (Session) + Sanctum (API) + Socialite (OAuth)
- Key Packages:
spatie/laravel-permission,spatie/media-library,webklex/laravel-imap
- Framework: Vue 3.5 (Composition API)
- State Management: Pinia
- Styling: Tailwind CSS 4.0 + Reka UI
- Build Tool: Vite 6.0
- Key Libraries:
tiptap(Rich Text),fullcalendar(Events),chart.js(Analytics),laravel-echo(Real-time)
Secure login with social auth and multi-factor authentication support.
Central hub for personal stats, tasks, and system overview.
Full-featured messaging with groups, file sharing, and typing indicators.
Task tracking, Kanban boards, and integrated calendar scheduling.
Internal support ticketing with automated workflows.
IMAP/SMTP inbox with folder management and rich text composition.
Visual insights and reporting.
Knowledge base management with public article publishing.
Markdown-supported personal note-taking app.
Role-based access control (RBAC), team management, and user profiles.
System health monitoring, queue management, and backups.
-
Clone the repository
git clone git@github.com:SummerRijndael/worksphere.git cd worksphere -
Install Dependencies
composer install npm install
-
Environment Setup
cp .env.example .env php artisan key:generate
Note: The
.envfile contains critical sensitive information. Never commit it to version control. Use.env.exampleas a template. -
Configure External Services
Open your
.envfile and populate the necessary service credentials.WorkSphere uses Laravel Reverb for real-time WebSocket communication (chat, notifications, presence).
REVERB_APP_ID=my-app-id REVERB_APP_KEY=my-app-key REVERB_APP_SECRET=my-app-secret REVERB_HOST="localhost" REVERB_PORT=8080 REVERB_SCHEME=http
Google Calendar Sync: You must enable the Google Calendar API in your Google Cloud Console and add the following redirect URI:
http://127.0.0.1:8000/callback/calendarGOOGLE_CLIENT_ID=your-google-client-id GOOGLE_CLIENT_SECRET=your-google-client-secret GOOGLE_REDIRECT_URI="${APP_URL}/auth/google/callback" GOOGLE_CALENDAR_REDIRECT_URI="${APP_URL}/callback/calendar"
The system supports both V2 (Checkbox) and V3 (Invisible) reCAPTCHA.
RECAPTCHA_ENABLED=true RECAPTCHA_V3_SITE_KEY=... RECAPTCHA_V3_SECRET_KEY=...
To enable Giphy support in Chat, obtain an API key from the Giphy Developers Portal.
GIPHY_API_KEY=your-giphy-api-keyThe system relies on several external services for full functionality. Populate these in
.env:- OpenAI: Required for AI-powered features. (
OPENAI_API_KEY, etc.) - Twilio: Used for SMS notifications and 2FA. (
TWILIO_SID,TWILIO_AUTH_TOKEN, etc.) - AWS S3: Recommended for production file storage. (
AWS_ACCESS_KEY_ID,AWS_BUCKET, etc.) - MaxMind/GeoIP: Required for location-based features. (
MAXMIND_LICENSE_KEY)
- OpenAI: Required for AI-powered features. (
-
Initialize System
php artisan migrate --seed php artisan storage:link
-
Run Application
npm run start-all
This command runs Laravel Serve, Reverb, Queue Worker (Horizon), and Vite concurrently.
Test Users:
admin@example.com/Xachgamb@01test@example.com/Xachgamb@01
- API-First: The backend serves as a headless API (
routes/api.php) protected by Sanctum. - SPA Frontend: The Vue app is served via a single entry point (
views/app.blade.php,routes/web.php). - Real-time: Events are broadcasted to private channels (
private-user.{id}) using Laravel Reverb. - Authorization: Strict Policy and Permission-based access control (RBAC).
- Authentication: Supports Password, Social Login (Google/GitHub), and 2FA (TOTP/SMS/WebAuthn/Passkeys).
- Rate Limiting: Strict throttling on auth endpoints and sensitive actions.
- Media: Private uploads are securely served via signed URLs.
For detailed internal documentation, open app_doc.html in your browser.
This project is licensed under the Apache License 2.0.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
© 2026 WorkSphere. Internal Development.