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

Update README with project roadmap and package details

Browse Source 
This commit introduces checkbox formatting for project's roadmap dates in the README, enhancing readability and visibility. Also, new details about the '@kit/database-webhooks', '@kit/cms', '@kit/next' packages, and the CMS additions to the application are included to provide clearer understanding of project's structure and functionality.
This commit is contained in:
giancarlo
2024-04-07 12:53:20 +08:00
parent 0002ac6255
commit 91811033f4
1 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -10,12 +10,12 @@ This version uses Turborepo to manage multiple packages in a single repository.
The roadmap for the project is as follows: The roadmap for the project is as follows:
1. **March 31**: Alpha release - authentication, personal accounts, team accounts (memberships) - [x] - **March 31**: Alpha release - authentication, personal accounts, team accounts (memberships)
2. **April 7**: Beta release - billing, Stripe, Lemon Squeezy, and more - [] - **April 7**: Beta release - billing, Stripe, Lemon Squeezy, and more
3. **April 14**: Release candidate - admin dashboard, translations, and more - [] - **April 14**: Release candidate - admin dashboard, translations, and more
4. **April 21**: Final Release candidate - in-app notifications, final features and improvements - [] - **April 21**: Final Release candidate - in-app notifications, final features and improvements
5. **April 28**: Stable release - final features and improvements - [] - **April 28**: Stable release - final features and improvements
6. **May 4**: Post-release - documentation, tutorials, and more - [] - **May 4**: Post-release - documentation, tutorials, and more
## Features ## Features
@@ -101,6 +101,9 @@ Below are the reusable packages that can be shared across multiple applications
- **`@kit/email-templates`**: Here we define the email templates using the `react.email` package. - **`@kit/email-templates`**: Here we define the email templates using the `react.email` package.
- **`@kit/mailers`**: Mailer package that abstracts the email service provider (e.g., Resend, Cloudflare, SendGrid, Mailgun, etc.) - **`@kit/mailers`**: Mailer package that abstracts the email service provider (e.g., Resend, Cloudflare, SendGrid, Mailgun, etc.)
- **`@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/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/database-webhooks`**: Database webhooks package that defines the actions following database changes (e.g., sending an email, updating a record, etc.)
- **`@kit/cms`**: CMS package that defines the schema and logic for managing content
- **`@kit/next`**: Next.js specific utilities
And features that can be added to the application: And features that can be added to the application:
- **`@kit/auth`**: Authentication package (using Supabase) - **`@kit/auth`**: Authentication package (using Supabase)
@@ -113,6 +116,10 @@ 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
The CMSs that can be added to the application:
- **`@kit/wordpress`**: WordPress package that defines the schema and logic for managing WordPress. This is used by the `@kit/cms` package and abstracts the WordPress API.
- **`@kit/contentlayer`**: Contentlayer package that defines the schema and logic for managing Contentlayer. This is used by the `@kit/cms` package and abstracts the Contentlayer API. Set to be replaced.
Also planned (post-release): Also planned (post-release):
- **`@kit/notifications`**: Notifications package that defines the schema and logic for managing notifications - **`@kit/notifications`**: Notifications package that defines the schema and logic for managing notifications
- **`@kit/plugins`**: Move the existing plugins to a separate package here - **`@kit/plugins`**: Move the existing plugins to a separate package here