zaid.marzguioui/myeasycms-v2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add information to README file

Browse Source 
More details about the web application have been included in the README.md file, along with details about future modules to be included post-release. This document now serves as a more comprehensive guide for users.
This commit is contained in:
giancarlo
2024-03-29 15:10:43 +08:00
parent 3be39e810b
commit 40c730141a
1 changed files with 8 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -70,6 +70,8 @@ pnpm dev
This command will run both the web application and the Supabase container. If the Supabase container is already running, it will only start the web application. This command will run both the web application and the Supabase container. If the Supabase container is already running, it will only start the web application.
Please refer to `apps/web/README.md` for more information about the web application.
## Architecture ## Architecture
This project uses Turborepo to manage multiple packages in a single repository. This project uses Turborepo to manage multiple packages in a single repository.
@@ -110,6 +112,12 @@ And billing packages that can be added to the application:
- **`@kit/lemon-squeezy`**: Lemon Squeezy package that defines the schema and logic for managing Lemon Squeezy. This is used by the `@kit/billing-gateway` package and abstracts the Lemon Squeezy API. (Coming soon) - **`@kit/lemon-squeezy`**: Lemon Squeezy package that defines the schema and logic for managing Lemon Squeezy. This is used by the `@kit/billing-gateway` package and abstracts the Lemon Squeezy API. (Coming soon)
- **`@kit/paddle`**: Paddle package that defines the schema and logic for managing Paddle. This is used by the `@kit/billing-gateway` package and abstracts the Paddle API. (Coming soon - **`@kit/paddle`**: Paddle package that defines the schema and logic for managing Paddle. This is used by the `@kit/billing-gateway` package and abstracts the Paddle API. (Coming soon
Also planned (post-release):
- **`@kit/notifications`**: Notifications package that defines the schema and logic for managing notifications
- **`@kit/monitoring`**: A unified monitoring package that defines the schema and logic for monitoring the application with third party services (e.g., Sentry, Baselime, etc.)
- **`@kit/plugins`**: Move the existing plugins to a separate package here
- **`@kit/analytics`**: A unified analytics package to track user behavior
### Application Configuration ### Application Configuration
The configuration is defined in the `apps/web/config` folder. Here you can find the following configuration files: The configuration is defined in the `apps/web/config` folder. Here you can find the following configuration files: