Synergy

Synergy is a comprehensive web application designed to manage organizational processes through a modular subscription system. By leveraging Laravel, Inertia.js, React, and TypeScript, Synergy provides a seamless experience for subscribing to various processes, managing billing cycles, and processing payments.

Features

• Laravel Backend: Robust backend framework for handling data processing, authentication, and business logic.
• Inertia.js: Modern SPA-like experience with server-side routing, providing a smooth user interface.
• React Frontend: Interactive and responsive UI built with React.
• TypeScript: Enhances code quality and maintainability with static typing.
• Modular Subscription: Subscribe to and manage various organizational processes.
• Flexible Billing: Support for monthly, biannual, and annual billing cycles.

Installation

Prerequisites

• PHP 8.2 or higher
• Composer
• Node.js and npm
• MySQL or another supported database

1. Clone the Repository

git clone https://github.com/maina-david/synergy.git
cd synergy

2. Install Backend Dependencies

composer install

3. Configure Environment

Copy the example environment file and set up your environment variables.

cp .env.example .env

Edit the .env file to configure your database and other settings.

4. Generate Application Key

php artisan key:generate

5. Run Database Migrations and Seeders and link storage

php artisan migrate --seed

php artisan storage:link

6. Install Frontend Dependencies

Install the dependencies:

npm install

7. Build Assets

Local development

npm run dev

Production

npm run build

8. Start the Development Server

• For Laravel:

php artisan serve

• For Vite:

npm run dev

Contributing

1. Fork the repository.
2. Create a feature branch.
3. Make your changes.
4. Submit a pull request.

License

This project is licensed under the MIT License.

Contact

For any questions or issues, please reach out to [email protected]