From 846c9c20d84ad5cc0381aa3da5df825b78366dd5 Mon Sep 17 00:00:00 2001 From: haasim vahora Date: Thu, 14 Nov 2024 13:05:08 +0700 Subject: [PATCH] feat: first update --- api-reference/endpoint/create.mdx | 4 - api-reference/endpoint/delete.mdx | 4 - api-reference/endpoint/get.mdx | 4 - api-reference/introduction.mdx | 33 ---- api-reference/openapi.json | 195 ------------------- development-tools/builder.mdx | 47 +++++ development-tools/database.mdx | 47 +++++ development-tools/deployment.mdx | 47 +++++ development-tools/design.mdx | 47 +++++ development-tools/github.mdx | 47 +++++ development-tools/local-development.mdx | 14 ++ development-tools/setup.mdx | 14 ++ development-tools/user-management.mdx | 47 +++++ global-salawat-challenge/global-rankings.mdx | 45 +++++ global-salawat-challenge/home.mdx | 66 +++++++ global-salawat-challenge/organizations.mdx | 36 ++++ global-salawat-dashboard/analytics.mdx | 53 +++++ global-salawat-dashboard/donations.mdx | 37 ++++ global-salawat-dashboard/organizations.mdx | 39 ++++ global-salawat-dashboard/pledges.mdx | 50 +++++ global-salawat-dashboard/settings.mdx | 59 ++++++ mint-backup.json | 91 +++++++++ mint.json | 100 ++++++---- 23 files changed, 852 insertions(+), 274 deletions(-) delete mode 100644 api-reference/endpoint/create.mdx delete mode 100644 api-reference/endpoint/delete.mdx delete mode 100644 api-reference/endpoint/get.mdx delete mode 100644 api-reference/introduction.mdx delete mode 100644 api-reference/openapi.json create mode 100644 development-tools/builder.mdx create mode 100644 development-tools/database.mdx create mode 100644 development-tools/deployment.mdx create mode 100644 development-tools/design.mdx create mode 100644 development-tools/github.mdx create mode 100644 development-tools/local-development.mdx create mode 100644 development-tools/setup.mdx create mode 100644 development-tools/user-management.mdx create mode 100644 global-salawat-challenge/global-rankings.mdx create mode 100644 global-salawat-challenge/home.mdx create mode 100644 global-salawat-challenge/organizations.mdx create mode 100644 global-salawat-dashboard/analytics.mdx create mode 100644 global-salawat-dashboard/donations.mdx create mode 100644 global-salawat-dashboard/organizations.mdx create mode 100644 global-salawat-dashboard/pledges.mdx create mode 100644 global-salawat-dashboard/settings.mdx create mode 100644 mint-backup.json diff --git a/api-reference/endpoint/create.mdx b/api-reference/endpoint/create.mdx deleted file mode 100644 index 5689f1b..0000000 --- a/api-reference/endpoint/create.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Create Plant' -openapi: 'POST /plants' ---- diff --git a/api-reference/endpoint/delete.mdx b/api-reference/endpoint/delete.mdx deleted file mode 100644 index 657dfc8..0000000 --- a/api-reference/endpoint/delete.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Delete Plant' -openapi: 'DELETE /plants/{id}' ---- diff --git a/api-reference/endpoint/get.mdx b/api-reference/endpoint/get.mdx deleted file mode 100644 index 56aa09e..0000000 --- a/api-reference/endpoint/get.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: 'Get Plants' -openapi: 'GET /plants' ---- diff --git a/api-reference/introduction.mdx b/api-reference/introduction.mdx deleted file mode 100644 index c835b78..0000000 --- a/api-reference/introduction.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: 'Introduction' -description: 'Example section for showcasing API endpoints' ---- - - - If you're not looking to build API reference documentation, you can delete - this section by removing the api-reference folder. - - -## Welcome - -There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification. - - - View the OpenAPI specification file - - -## Authentication - -All API endpoints are authenticated using Bearer tokens and picked up from the specification file. - -```json -"security": [ - { - "bearerAuth": [] - } -] -``` diff --git a/api-reference/openapi.json b/api-reference/openapi.json deleted file mode 100644 index b1509be..0000000 --- a/api-reference/openapi.json +++ /dev/null @@ -1,195 +0,0 @@ -{ - "openapi": "3.0.1", - "info": { - "title": "OpenAPI Plant Store", - "description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification", - "license": { - "name": "MIT" - }, - "version": "1.0.0" - }, - "servers": [ - { - "url": "http://sandbox.mintlify.com" - } - ], - "security": [ - { - "bearerAuth": [] - } - ], - "paths": { - "/plants": { - "get": { - "description": "Returns all plants from the system that the user has access to", - "parameters": [ - { - "name": "limit", - "in": "query", - "description": "The maximum number of results to return", - "schema": { - "type": "integer", - "format": "int32" - } - } - ], - "responses": { - "200": { - "description": "Plant response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/Plant" - } - } - } - } - }, - "400": { - "description": "Unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - }, - "post": { - "description": "Creates a new plant in the store", - "requestBody": { - "description": "Plant to add to the store", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/NewPlant" - } - } - }, - "required": true - }, - "responses": { - "200": { - "description": "plant response", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Plant" - } - } - } - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - }, - "/plants/{id}": { - "delete": { - "description": "Deletes a single plant based on the ID supplied", - "parameters": [ - { - "name": "id", - "in": "path", - "description": "ID of plant to delete", - "required": true, - "schema": { - "type": "integer", - "format": "int64" - } - } - ], - "responses": { - "204": { - "description": "Plant deleted", - "content": {} - }, - "400": { - "description": "unexpected error", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/Error" - } - } - } - } - } - } - } - }, - "components": { - "schemas": { - "Plant": { - "required": [ - "name" - ], - "type": "object", - "properties": { - "name": { - "description": "The name of the plant", - "type": "string" - }, - "tag": { - "description": "Tag to specify the type", - "type": "string" - } - } - }, - "NewPlant": { - "allOf": [ - { - "$ref": "#/components/schemas/Plant" - }, - { - "required": [ - "id" - ], - "type": "object", - "properties": { - "id": { - "description": "Identification number of the plant", - "type": "integer", - "format": "int64" - } - } - } - ] - }, - "Error": { - "required": [ - "error", - "message" - ], - "type": "object", - "properties": { - "error": { - "type": "integer", - "format": "int32" - }, - "message": { - "type": "string" - } - } - } - }, - "securitySchemes": { - "bearerAuth": { - "type": "http", - "scheme": "bearer" - } - } - } -} \ No newline at end of file diff --git a/development-tools/builder.mdx b/development-tools/builder.mdx new file mode 100644 index 0000000..ef48bdd --- /dev/null +++ b/development-tools/builder.mdx @@ -0,0 +1,47 @@ +## Introduction + +Builder.io is a powerful tool for managing and updating your website content. This guide will walk you through the process of logging in, navigating to your pages, and making changes to your site. + +## **Steps to Update Your Site** + +### **1. Log In** + +- Visit the Builder.io website and log in with your credentials. + +### **2. Access Your Pages** + +- Once logged in, navigate to the **Content** section. +- Use the left-hand menu to find the **Content Type** tab. +- Here, you will see a list of your pages. Click on the page you want to edit (e.g., "home"). + +### **3. Navigate to Sections** + +- After selecting a page, you will see a list of sections on the left side (e.g., HeaderBuilder, HomeHeroSectionBuilder). +- Click on the section you wish to update. + +### **4. Edit Section Options** + +- With a section selected, go to the **Options** tab on the right. +- Here, you can adjust various settings such as: +- **Background color** +- **Text color** +- **Images (Logo src)** +- **Links (Logo href, Seerah store href)** + +### **5. Make Your Changes** + +- Adjust the colors, text, and images as needed. +- Ensure all changes reflect your desired updates. + +### **6. Publish Your Changes** + +- Once you have made your adjustments, click the **Publish** button at the top right to make your changes live. +- Changes will be reflected after 10 seconds + +## **Tips** + +- **Preview Changes**: Use the preview option to see how your changes will look before publishing. +- **Version Control**: Keep track of different versions of your page to easily revert if needed. +- **Feedback**: Use the feedback option to report any issues or get help. + +By following these steps, you can efficiently manage and update your website using Builder.io. \ No newline at end of file diff --git a/development-tools/database.mdx b/development-tools/database.mdx new file mode 100644 index 0000000..ef48bdd --- /dev/null +++ b/development-tools/database.mdx @@ -0,0 +1,47 @@ +## Introduction + +Builder.io is a powerful tool for managing and updating your website content. This guide will walk you through the process of logging in, navigating to your pages, and making changes to your site. + +## **Steps to Update Your Site** + +### **1. Log In** + +- Visit the Builder.io website and log in with your credentials. + +### **2. Access Your Pages** + +- Once logged in, navigate to the **Content** section. +- Use the left-hand menu to find the **Content Type** tab. +- Here, you will see a list of your pages. Click on the page you want to edit (e.g., "home"). + +### **3. Navigate to Sections** + +- After selecting a page, you will see a list of sections on the left side (e.g., HeaderBuilder, HomeHeroSectionBuilder). +- Click on the section you wish to update. + +### **4. Edit Section Options** + +- With a section selected, go to the **Options** tab on the right. +- Here, you can adjust various settings such as: +- **Background color** +- **Text color** +- **Images (Logo src)** +- **Links (Logo href, Seerah store href)** + +### **5. Make Your Changes** + +- Adjust the colors, text, and images as needed. +- Ensure all changes reflect your desired updates. + +### **6. Publish Your Changes** + +- Once you have made your adjustments, click the **Publish** button at the top right to make your changes live. +- Changes will be reflected after 10 seconds + +## **Tips** + +- **Preview Changes**: Use the preview option to see how your changes will look before publishing. +- **Version Control**: Keep track of different versions of your page to easily revert if needed. +- **Feedback**: Use the feedback option to report any issues or get help. + +By following these steps, you can efficiently manage and update your website using Builder.io. \ No newline at end of file diff --git a/development-tools/deployment.mdx b/development-tools/deployment.mdx new file mode 100644 index 0000000..ef48bdd --- /dev/null +++ b/development-tools/deployment.mdx @@ -0,0 +1,47 @@ +## Introduction + +Builder.io is a powerful tool for managing and updating your website content. This guide will walk you through the process of logging in, navigating to your pages, and making changes to your site. + +## **Steps to Update Your Site** + +### **1. Log In** + +- Visit the Builder.io website and log in with your credentials. + +### **2. Access Your Pages** + +- Once logged in, navigate to the **Content** section. +- Use the left-hand menu to find the **Content Type** tab. +- Here, you will see a list of your pages. Click on the page you want to edit (e.g., "home"). + +### **3. Navigate to Sections** + +- After selecting a page, you will see a list of sections on the left side (e.g., HeaderBuilder, HomeHeroSectionBuilder). +- Click on the section you wish to update. + +### **4. Edit Section Options** + +- With a section selected, go to the **Options** tab on the right. +- Here, you can adjust various settings such as: +- **Background color** +- **Text color** +- **Images (Logo src)** +- **Links (Logo href, Seerah store href)** + +### **5. Make Your Changes** + +- Adjust the colors, text, and images as needed. +- Ensure all changes reflect your desired updates. + +### **6. Publish Your Changes** + +- Once you have made your adjustments, click the **Publish** button at the top right to make your changes live. +- Changes will be reflected after 10 seconds + +## **Tips** + +- **Preview Changes**: Use the preview option to see how your changes will look before publishing. +- **Version Control**: Keep track of different versions of your page to easily revert if needed. +- **Feedback**: Use the feedback option to report any issues or get help. + +By following these steps, you can efficiently manage and update your website using Builder.io. \ No newline at end of file diff --git a/development-tools/design.mdx b/development-tools/design.mdx new file mode 100644 index 0000000..ef48bdd --- /dev/null +++ b/development-tools/design.mdx @@ -0,0 +1,47 @@ +## Introduction + +Builder.io is a powerful tool for managing and updating your website content. This guide will walk you through the process of logging in, navigating to your pages, and making changes to your site. + +## **Steps to Update Your Site** + +### **1. Log In** + +- Visit the Builder.io website and log in with your credentials. + +### **2. Access Your Pages** + +- Once logged in, navigate to the **Content** section. +- Use the left-hand menu to find the **Content Type** tab. +- Here, you will see a list of your pages. Click on the page you want to edit (e.g., "home"). + +### **3. Navigate to Sections** + +- After selecting a page, you will see a list of sections on the left side (e.g., HeaderBuilder, HomeHeroSectionBuilder). +- Click on the section you wish to update. + +### **4. Edit Section Options** + +- With a section selected, go to the **Options** tab on the right. +- Here, you can adjust various settings such as: +- **Background color** +- **Text color** +- **Images (Logo src)** +- **Links (Logo href, Seerah store href)** + +### **5. Make Your Changes** + +- Adjust the colors, text, and images as needed. +- Ensure all changes reflect your desired updates. + +### **6. Publish Your Changes** + +- Once you have made your adjustments, click the **Publish** button at the top right to make your changes live. +- Changes will be reflected after 10 seconds + +## **Tips** + +- **Preview Changes**: Use the preview option to see how your changes will look before publishing. +- **Version Control**: Keep track of different versions of your page to easily revert if needed. +- **Feedback**: Use the feedback option to report any issues or get help. + +By following these steps, you can efficiently manage and update your website using Builder.io. \ No newline at end of file diff --git a/development-tools/github.mdx b/development-tools/github.mdx new file mode 100644 index 0000000..ef48bdd --- /dev/null +++ b/development-tools/github.mdx @@ -0,0 +1,47 @@ +## Introduction + +Builder.io is a powerful tool for managing and updating your website content. This guide will walk you through the process of logging in, navigating to your pages, and making changes to your site. + +## **Steps to Update Your Site** + +### **1. Log In** + +- Visit the Builder.io website and log in with your credentials. + +### **2. Access Your Pages** + +- Once logged in, navigate to the **Content** section. +- Use the left-hand menu to find the **Content Type** tab. +- Here, you will see a list of your pages. Click on the page you want to edit (e.g., "home"). + +### **3. Navigate to Sections** + +- After selecting a page, you will see a list of sections on the left side (e.g., HeaderBuilder, HomeHeroSectionBuilder). +- Click on the section you wish to update. + +### **4. Edit Section Options** + +- With a section selected, go to the **Options** tab on the right. +- Here, you can adjust various settings such as: +- **Background color** +- **Text color** +- **Images (Logo src)** +- **Links (Logo href, Seerah store href)** + +### **5. Make Your Changes** + +- Adjust the colors, text, and images as needed. +- Ensure all changes reflect your desired updates. + +### **6. Publish Your Changes** + +- Once you have made your adjustments, click the **Publish** button at the top right to make your changes live. +- Changes will be reflected after 10 seconds + +## **Tips** + +- **Preview Changes**: Use the preview option to see how your changes will look before publishing. +- **Version Control**: Keep track of different versions of your page to easily revert if needed. +- **Feedback**: Use the feedback option to report any issues or get help. + +By following these steps, you can efficiently manage and update your website using Builder.io. \ No newline at end of file diff --git a/development-tools/local-development.mdx b/development-tools/local-development.mdx new file mode 100644 index 0000000..9986950 --- /dev/null +++ b/development-tools/local-development.mdx @@ -0,0 +1,14 @@ +--- +title: 'Local Development' +description: 'Running the platform locally' +--- + +## Introduction + +Guide for running and testing the platform in a local environment. + +## Getting Started + +1. Local server setup +2. Database configuration +3. Testing environment \ No newline at end of file diff --git a/development-tools/setup.mdx b/development-tools/setup.mdx new file mode 100644 index 0000000..138ff19 --- /dev/null +++ b/development-tools/setup.mdx @@ -0,0 +1,14 @@ +--- +title: 'Development Tools Setup' +description: 'Setting up development tools' +--- + +## Introduction + +Learn how to set up the development environment for the Global Salawat platform. + +## Requirements + +- Development environment setup +- Required tools and software +- Configuration guidelines \ No newline at end of file diff --git a/development-tools/user-management.mdx b/development-tools/user-management.mdx new file mode 100644 index 0000000..ef48bdd --- /dev/null +++ b/development-tools/user-management.mdx @@ -0,0 +1,47 @@ +## Introduction + +Builder.io is a powerful tool for managing and updating your website content. This guide will walk you through the process of logging in, navigating to your pages, and making changes to your site. + +## **Steps to Update Your Site** + +### **1. Log In** + +- Visit the Builder.io website and log in with your credentials. + +### **2. Access Your Pages** + +- Once logged in, navigate to the **Content** section. +- Use the left-hand menu to find the **Content Type** tab. +- Here, you will see a list of your pages. Click on the page you want to edit (e.g., "home"). + +### **3. Navigate to Sections** + +- After selecting a page, you will see a list of sections on the left side (e.g., HeaderBuilder, HomeHeroSectionBuilder). +- Click on the section you wish to update. + +### **4. Edit Section Options** + +- With a section selected, go to the **Options** tab on the right. +- Here, you can adjust various settings such as: +- **Background color** +- **Text color** +- **Images (Logo src)** +- **Links (Logo href, Seerah store href)** + +### **5. Make Your Changes** + +- Adjust the colors, text, and images as needed. +- Ensure all changes reflect your desired updates. + +### **6. Publish Your Changes** + +- Once you have made your adjustments, click the **Publish** button at the top right to make your changes live. +- Changes will be reflected after 10 seconds + +## **Tips** + +- **Preview Changes**: Use the preview option to see how your changes will look before publishing. +- **Version Control**: Keep track of different versions of your page to easily revert if needed. +- **Feedback**: Use the feedback option to report any issues or get help. + +By following these steps, you can efficiently manage and update your website using Builder.io. \ No newline at end of file diff --git a/global-salawat-challenge/global-rankings.mdx b/global-salawat-challenge/global-rankings.mdx new file mode 100644 index 0000000..17140b8 --- /dev/null +++ b/global-salawat-challenge/global-rankings.mdx @@ -0,0 +1,45 @@ +## Introduction + +The Global Rankings page displays the top-ranking countries based on the total Salawat pledged in the Global Salawat Challenge. This guide explains each section and how users can interpret and interact with the page. + +## Features + +### 1. **Header Section** + +- **Navigation Links**: At the top, the navigation bar provides links to other resources related to the challenge: + - **Proclamation**: Information on the significance and purpose of the challenge. + - **Benefits of Salawat**: Learn about the spiritual benefits of sending blessings. + - **Seerah Store**: A store dedicated to resources and merchandise. + - **Programs**: View additional programs organized by Celebrate Mercy. + +### 2. **Global Rankings Table** + +- The main table displays a leaderboard ranking the countries by the amount of Salawat pledged. The columns include: + - **Rank**: The country’s position based on the total Salawat pledged, with the highest-ranking country at the top. + - **Country**: The name and flag of the country. + - **Salawat Pledged**: The total number of Salawat pledged by each country. + - **Today’s Pledges (Last 24 Hours)**: Shows the number of new pledges from each country within the past 24 hours. Positive numbers indicate an increase, while blank fields indicate no recent pledges. +- This leaderboard highlights the countries making the most significant contributions, fostering a sense of global community and friendly competition. + +### 3. **Live Salawat Totals** + +- This section, located below the rankings table, displays the overall totals for the challenge: + - **Pledges**: The cumulative number of pledges made globally. + - **Countries**: The total number of countries participating in the challenge. + - **Salawat Pledged**: The overall number of Salawat pledged across all countries. +- This summary provides users with a snapshot of the global engagement in the challenge. + +### 4. **Recent Pledges Carousel** + +- A scrolling carousel below the live totals showcases recent pledges from around the world. Each pledge card displays: + - **Country Flag and Name**: The country from which the pledge was made. + - **Pledge Amount**: The number of Salawat pledged. +- This section highlights individual contributions, showing the ongoing activity and participation from various countries. + +### 5. **Footer** + +- The footer provides additional links and resources related to the Global Salawat Challenge: + - **Contact Links**: Quick access to contact pages, the store, proclamation, and programs associated with the challenge. + - **Privacy Policy and Terms & Conditions**: Links to the legal terms governing the use of the website and challenge participation. + - **Social Media Links**: Icons for popular social media platforms, allowing users to connect with Celebrate Mercy and share the challenge on social media. +- **Copyright Notice**: Indicates that all content is protected and provides the year of copyright. \ No newline at end of file diff --git a/global-salawat-challenge/home.mdx b/global-salawat-challenge/home.mdx new file mode 100644 index 0000000..cbf7452 --- /dev/null +++ b/global-salawat-challenge/home.mdx @@ -0,0 +1,66 @@ +## Introduction + +This page is the main entry point for participating in the Global Salawat Challenge, where users can pledge Salawat (blessings) on the Prophet Muhammad ﷺ and view global contributions. This guide explains each section and how users can interact with the page. + +## Features + +### 1. **Header Section** + +- **Proclamation, Benefits of Salawat, Search Store, Programs**: The navigation links at the top of the page provide quick access to additional resources and features: + - **Proclamation**: Learn about the purpose and impact of the Global Salawat Challenge. + - **Benefits of Salawat**: Explore the spiritual benefits of Salawat. + - **Search Store**: Find merchandise or resources associated with the challenge. + - **Programs**: Discover other programs and initiatives organized by Celebrate Mercy. + +### 2. **Main Banner - Join the Global Salawat Challenge for Rabi’ul Awwal** + +- This prominent section invites visitors to participate in the challenge. It contains key information and live statistics: + - **Live Salawat Totals**: Shows the current totals for: + - **Pledges**: The total number of pledges made worldwide. + - **Countries**: The number of countries participating. + - **Salawat Recited**: The total count of Salawat recited. + +### 3. **Pledge Your Salawat Form** + +- On the right side of the banner, visitors can make a pledge by filling out a simple form: + - **Full Name**: Enter your name. + - **Email**: Provide a valid email address to receive updates and acknowledgments. + - **Enter Your Pledge Amount**: Input the number of Salawat you intend to pledge. + - **Location**: Automatically detected based on the user’s IP. If it’s incorrect, they can click **Wrong Location? Click Here** to adjust it. +- Click **Pledge** to submit the pledge. After submission, your pledge will contribute to the live totals. + +### 4. **Arabic Invocation Section** + +- This section displays the Arabic phrase for invoking blessings on the Prophet Muhammad ﷺ. Below it, the translation reads: “O Allah! Bless Muhammad.” This serves as a reminder of the purpose of the challenge and creates a spiritual ambiance for the page. + +### 5. **Salawat Pledges From Around the World** + +- This section showcases recent Salawat pledges made globally. Each pledge card displays: + - **Pledge Amount**: Number of Salawat pledged. + - **Country Flag and Location**: The country and location from which the pledge was made. +- This feature highlights the collective participation in the challenge from various parts of the world, fostering a sense of global unity. + +### 6. **Call to Action - Join the Movement** + +- A button labeled **Pledge Your Salawat** invites visitors to join the movement if they haven’t already done so. Clicking this button scrolls up to the pledge form at the top of the page. + +### 7. **Top Countries by Salawat Pledged** + +- This section provides a leaderboard-style ranking of the top countries by the amount of Salawat pledged. The table includes: + - **Rank**: Country’s position in the leaderboard. + - **Country**: Name and flag of the country. + - **Salawat Pledged**: Total number of Salawat pledged from that country. + - **Today’s Pledges**: The number of pledges made in the past 24 hours, with a positive number indicating an increase. +- Click **View Full Rankings** to see a detailed list of all countries participating in the challenge. + +### 8. **Call to Action - Your Blessings Are Waiting** + +- This section includes an image of a mosque and a button that reads **Pledge Your Salawat**. It serves as another prompt for users to make a pledge, emphasizing the spiritual rewards of participating in the challenge. + +### 9. **Footer** + +- The footer provides links and contact information related to Celebrate Mercy and the Global Salawat Challenge: + - **Organized by Celebrate Mercy**: Displays the organizer’s name and logo. + - **Contact Links**: Links to contact pages, store, privacy policy, terms and conditions, and programs. + - **Social Media Links**: Icons for sharing or following Celebrate Mercy on social media platforms, allowing users to connect and spread the word. + - **Copyright Notice**: Ensures users that the content on the page is legally protected. \ No newline at end of file diff --git a/global-salawat-challenge/organizations.mdx b/global-salawat-challenge/organizations.mdx new file mode 100644 index 0000000..570a8e6 --- /dev/null +++ b/global-salawat-challenge/organizations.mdx @@ -0,0 +1,36 @@ +## Introduction + +The Organization Leaderboard page displays the top organizations contributing to the Global Salawat Challenge, ranked by the amount of Salawat pledged. This guide explains the elements of the page and how users can interpret and interact with the information. + +## Features + +### 1. **Header Section** + +- **Navigation Links**: At the top, the navigation bar provides links to other resources related to the challenge: + - **Proclamation**: Information on the significance and purpose of the challenge. + - **Benefits of Salawat**: Learn about the spiritual benefits of sending blessings. + - **Seerah Store**: A store dedicated to resources and merchandise. + - **Programs**: View additional programs organized by Celebrate Mercy. + +### 2. **Organization Leaderboard Table** + +- The main table on this page ranks the organizations that have pledged Salawat, listing them by the total amount pledged. The columns include: + - **Rank**: Shows the organization’s current rank based on the total Salawat pledged. + - **Organization**: The name of the organization, along with an icon or logo (if available) for easy identification. + - **Salawat Pledged**: The total number of Salawat pledged by each organization. + - **Today’s Pledges (Last 24 Hours)**: Displays the number of pledges made by each organization within the past 24 hours. If there is no recent activity, the field may be left blank. +- This leaderboard highlights the top organizations contributing to the challenge and provides insight into the organizations driving significant Salawat pledges. + +### 3. **Organized and Supported By Section** + +- This section, located below the leaderboard, displays logos for the organizations involved in managing and supporting the Global Salawat Challenge: + - **Organized by**: Shows the primary organizer, Celebrate Mercy. + - **Supported by**: Lists other organizations or partners supporting the challenge, with their logos displayed for recognition. + +### 4. **Footer** + +- The footer provides additional links and resources related to the Global Salawat Challenge: + - **Contact Links**: Quick access to contact pages, the store, proclamation, and programs associated with the challenge. + - **Privacy Policy and Terms & Conditions**: Links to the legal terms governing the use of the website and challenge participation. + - **Social Media Links**: Icons for popular social media platforms, allowing users to connect with Celebrate Mercy and share the challenge on social media. +- **Copyright Notice**: Indicates that all content is protected and provides the year of copyright. \ No newline at end of file diff --git a/global-salawat-dashboard/analytics.mdx b/global-salawat-dashboard/analytics.mdx new file mode 100644 index 0000000..661c444 --- /dev/null +++ b/global-salawat-dashboard/analytics.mdx @@ -0,0 +1,53 @@ +## Introduction + +The Global Salawat Challenge Dashboard is designed to help you track pledges, donations, and participation in the challenge. Here’s a quick guide to understand each section and use the system efficiently. + +## Features + +### 1. **Navigation Menu** + +- Located on the left side, this menu helps you access different parts of the dashboard: + - **Analytics**: Provides a summary of the challenge’s overall performance. + - **Pledges**: Shows detailed information on all pledges made. + - **Organizations**: Lists participating organizations. + - **Donations**: Displays donation details. + - **Settings**: For adjusting personal preferences in the system. + +### 2. **Date Filter** + +- At the top of the dashboard, there are **From Date** and **To Date** fields. +- Use these to specify a date range for the data you want to view. Click the calendar icon to select a date, then press the "X" to clear it if needed. + +### 3. **Analytics Overview** + +- This section provides key metrics at a glance: + - **Total Salawat**: The total number of Salawat pledges made. + - **Total Countries**: The number of countries where pledges originated. + - **Total Pledges**: The number of individual pledges made. + - **Total Donations**: The amount donated to the challenge. + - **Total Unique Emails**: Count of unique participants based on their email addresses. + - **Total Organizations**: Number of organizations involved in the challenge. + +### 4. **Daily Salawat Chart** + +- This bar chart shows the number of Salawat pledged each day within your selected date range. +- Hover over the bars to see exact numbers for each day. + +### 5. **Donations Chart** + +- This chart displays donation amounts over time, broken down by day. +- Use this to track the daily progression of donations and identify peak donation days. + +### 6. **Recent Pledges Table** + +- Located at the bottom of the dashboard, this table lists the most recent pledges. +- **Columns**: + - **Name**: Name of the person or group who pledged. + - **Amount**: Number of Salawat pledged. + - **Email**: Contact email of the pledge participant. + - **Country**: Country of origin. + - **Source**: Where the pledge was made from. + - **Date**: Date of the pledge. + - **IP**: The IP address from which the pledge was made. +- **Actions**: + - **Delete**: Click this button to remove a pledge entry if necessary. \ No newline at end of file diff --git a/global-salawat-dashboard/donations.mdx b/global-salawat-dashboard/donations.mdx new file mode 100644 index 0000000..6bd1fda --- /dev/null +++ b/global-salawat-dashboard/donations.mdx @@ -0,0 +1,37 @@ +## Introduction + +The Donations page helps you view, filter, and export donation data associated with the challenge. Use this guide to understand each section and learn how to use the page effectively. + +## Features + +### 1. **Donations Overview** + +- At the top of the page, you’ll find a summary displaying the **Total Donations** amount. This number reflects the cumulative donations made for the challenge to date. + +### 2. **Export to CSV** + +- Click the **Export to CSV** button to download a CSV file containing all donation records. This is useful for offline record-keeping or further analysis in spreadsheet applications. + +### 3. **Filters** + +- Below the Export to CSV button, there are multiple filters to help you search for specific donations: + - **Filter by name**: Enter a donor’s name to display only donations from that person. + - **Filter by email**: Enter an email address to display donations associated with that email. + - **Pick a date**: Click on this field to specify a date or date range for the donations you want to view. + - **Page Size**: Use this dropdown to select the number of rows displayed per page (e.g., 10, 25, 50). + +### 4. **Donations Table** + +- The **Donations** table provides detailed information for each donation entry, organized in columns: + - **ID**: A unique transaction identifier for each donation. + - **Name**: The name of the donor. + - **Email**: The email address of the donor. + - **Amount**: The donation amount contributed. + - **Stripe Fee**: The transaction fee deducted by Stripe for processing the donation. + - **Currency**: The currency in which the donation was made (e.g., USD). + - **Date**: The date and time when the donation was made. +- This table allows you to see a complete breakdown of donations, including fees and the precise time of each transaction. + +### 5. **Pagination** + +- If there are more donation records than can fit on a single page, use the pagination controls at the bottom of the table to navigate between pages. You can click a specific page number to jump to that page or use the "Next" button to move forward. \ No newline at end of file diff --git a/global-salawat-dashboard/organizations.mdx b/global-salawat-dashboard/organizations.mdx new file mode 100644 index 0000000..d25643c --- /dev/null +++ b/global-salawat-dashboard/organizations.mdx @@ -0,0 +1,39 @@ +## Introduction + +The Organizations page allows you to add new organizations, generate unique referral links, and manage existing organizations associated with the challenge. Use this guide to understand each feature and learn how to use the page effectively. + +## Features + +### 1. **Add New Organization** + +- At the top of the page, this section allows you to add an organization with a unique referral link for tracking purposes. Here’s how to fill out each field: + - **Name**: Enter the name of the organization. + - **Unique Referral Link**: Enter a custom source name for the organization. This will automatically generate a **Full URL** that you can share with the organization. + - **Full URL**: This is the unique link generated based on the source name. It can be copied directly by clicking **Copy Full URL** and shared with the organization for tracking referrals. + - **Photo URL**: Paste the URL of the organization’s logo or photo to visually represent them in the list. +- Once all fields are complete, click **Submit Organization** to save the new organization entry. + +### 2. **Organizations Table** + +- The **Organizations** table lists all the organizations added to the system, displaying key information and allowing easy access to their referral links and other actions. +- **Columns**: + - **Name**: The name of the organization. + - **Organization Logo**: A link to the organization’s logo or photo. + - **Unique Referral Link**: The custom referral link generated for the organization, displayed in two parts: + - **Full URL**: Shows the complete referral link for easy copying. Click **Copy Full URL** to copy the link to your clipboard. + - **Edit source**: Allows you to modify the unique source identifier (the part of the URL after `?src=`) if needed. Simply click on it, edit the text, and save changes. +- **Delete Button**: Located on the far right of each row, this button allows you to remove an organization from the list. Click "Delete" to confirm the removal. + +### 3. **Export to CSV** + +- Click the **Export to CSV** button to download a CSV file containing the list of all organizations and their referral information. This is useful for offline record-keeping or analyzing the data in spreadsheet applications. + +### 4. **Filters** + +- Below the Export to CSV button, there are filters to help you narrow down the list of organizations: + - **Filter by name**: Type the name of an organization to display only matching entries in the table. + - **Page Size**: Use this dropdown to select the number of entries displayed per page (e.g., 10, 25, 50). + +### 5. **Pagination** + +- If there are more organizations than can fit on a single page, use the pagination controls at the bottom of the table to navigate through pages. You can go to a specific page by clicking the page number or use the "Next" button to move forward. \ No newline at end of file diff --git a/global-salawat-dashboard/pledges.mdx b/global-salawat-dashboard/pledges.mdx new file mode 100644 index 0000000..24cff73 --- /dev/null +++ b/global-salawat-dashboard/pledges.mdx @@ -0,0 +1,50 @@ +## Introduction + +The Pledges page allows you to add new pledges, review and filter existing pledges, and view the countries that have joined the challenge. This guide provides an overview of each feature and step-by-step instructions on how to use them. + +## Features + +### 1. **Add New Pledge** + +- Located at the top of the page, this section allows you to manually add a new pledge. Here’s how: + - **Name**: Enter the name of the person or group making the pledge. + - **Amount Pledged**: Input the number of Salawat (prayers) pledged. + - **Email**: Enter the contact email for the pledge. + - **Country**: Select the participant’s country from the dropdown menu. + - **Source**: Optionally, enter the source platform or event where the pledge originated (e.g., online form, event name). + - **Date**: Choose the date of the pledge by clicking on the calendar icon. +- After filling out all required fields, click **Submit Pledge** to save the entry. + +### 2. **Pledges Table** + +- Below the Add New Pledge section, you’ll find the **Pledges** table, which displays all submitted pledges. Each row represents an individual pledge, showing essential information: + - **Name**: Name of the person or group. + - **Amount**: Amount of Salawat pledged. + - **Email**: Email of the participant. + - **Country**: The participant’s country. + - **Source**: The source from which the pledge was made. + - **Date**: Date the pledge was submitted. + - **IP**: IP address from which the pledge was submitted. +- **Delete** Button: Located on the far right of each row, this button allows you to delete a pledge if needed. Simply click "Delete" to remove the entry from the list. + +### 3. **Export to CSV** + +- The **Export to CSV** button allows you to download the entire list of pledges in a CSV file format. This is helpful for keeping offline records or further analyzing pledge data in spreadsheet software like Excel. + +### 4. **Filters** + +- This section, below the date filters, lets you narrow down the pledge list by different criteria: + - **Filter by Email**: Type an email address to show only pledges made by that email. + - **Select Country**: Use this dropdown to display pledges from a specific country. + - **Filter by Source**: Type a source name to filter by a specific origin of the pledges (e.g., “Event 2024”). + - **Page Size**: Use this dropdown to adjust the number of rows displayed per page (e.g., 10, 25, 50). +- **Date Filters**: Above the filters, you can specify a date range for viewing pledges. Set the **From Date** and **To Date** fields to show pledges within a specific timeframe. Clear the fields using the “X” icon to reset. + +### 5. **Pagination** + +- At the bottom of the pledges table, pagination controls allow you to navigate between pages if there are more pledges than can fit on one page. Use the numbered buttons to go directly to a page or the "Next" button to move forward. + +### 6. **Countries Added** + +- At the bottom of the page, you’ll find the **Countries Added** section, which displays a list of all the countries that have joined the challenge and the date each country was first added. +- This list updates as new countries join, helping you track the geographical reach of the challenge. \ No newline at end of file diff --git a/global-salawat-dashboard/settings.mdx b/global-salawat-dashboard/settings.mdx new file mode 100644 index 0000000..13cc41d --- /dev/null +++ b/global-salawat-dashboard/settings.mdx @@ -0,0 +1,59 @@ +## Introduction + +The Settings page enables you to configure key parameters for managing pledges, donations, and general application settings for the Global Salawat Challenge. This guide will help you understand each setting and how to adjust it according to your requirements. + +## Features + +### Navigation within Settings + +- On the left side of the **Settings** page, there are four sections for specific settings: + - **General Settings**: Configure the main application limits and sponsor information. + - **Pledge Settings**: Adjust settings related to pledge submissions (not shown in detail here). + - **Donation Settings**: Customize settings related to donations (not shown in detail here). + - **Country Settings**: Manage country-specific settings (not shown in detail here). + +### 1. **General Settings** + +- This section, displayed by default, contains fields that control the main parameters for pledges and Salawat limits, as well as sponsor information. Here’s how to configure each setting: + - **Total Pledges allowed per email**: Set the maximum number of pledges that can be made from a single email address. This helps prevent spam or misuse by limiting repeated entries. + - **Total Salawat allowed per email**: Define the maximum number of Salawat (prayers) that can be pledged from a single email address. This is useful for controlling high pledge numbers from individual users. + - **Total Salawat allowed per day for unique IP**: Specify the maximum number of Salawat that can be pledged per day from a unique IP address. This helps prevent excessive entries from a single IP. + - **Total pledges allowed per day from unique IP**: Set the maximum number of pledges that can be submitted per day from a unique IP address. This ensures that no IP address is used to bypass pledge limits. + - **Sponsor Name**: Enter the name of the sponsor, if any, associated with the Salawat challenge. This name may appear in public-facing parts of the application or reports. +- **Save Changes**: After making adjustments, click the **Save Changes** button to apply the updated settings. Make sure to save each time you update any setting to ensure changes take effect. + +### 2. Pledge Settings + +- This section allows you to define preset Salawat pledge amounts that participants can select when making a pledge. You can enable or disable specific amounts and add custom options based on your needs. + - **Pledge Settings Options**: This list shows preset pledge amounts. You can enable or disable each amount by checking or unchecking the box next to it. If an amount is disabled, it will not appear as an option for participants. + - Available options include: 300, 500, 1000, 2000, 5000, 10000, 20000, and 30000. + - To remove an amount, click the **X** next to it. + - **Add Custom Pledge Settings Amount**: If you want to provide an additional pledge amount option not listed in the preset options, enter the amount in the text box and click **Add**. This custom amount will appear in the list of available pledge amounts. + - **Save Changes**: Once you have configured the pledge amounts to your preference, click the **Save Changes** button to apply the settings. Be sure to save each time you make updates to ensure the changes are implemented. + +### 3. Donation Settings + +- Th**is** section lets you set up preset donation amounts for both one-time and monthly donations. You can enable or disable specific amounts and add custom options according to your requirements. + - **One-Time Donation Settings** + - **Donation Settings Options**: This list displays preset options for one-time donation amounts. You can enable or disable each amount by checking or unchecking the box next to it. If an amount is disabled, it will not be available as an option for donors. + - Available options include: $10, $30, $50, $100, $300, and $500. + - To remove an amount, click the **X** next to it. + - **Add Custom Donation Settings Amount**: To provide an additional one-time donation amount that isn’t listed, enter the amount in the text box and click **Add**. The custom amount will be added to the list of available options. + - **Monthly Donation Settings** + - **Monthly Donation Settings Options**: This list shows preset options for recurring monthly donation amounts. Similar to the one-time settings, you can enable or disable each option by checking or unchecking the boxes. + - Available options include: $30, $50, $100, $150, $300, and $500. + - To remove an amount, click the **X** next to it. + - **Add Custom Monthly Donation Settings Amount**: If you want to add a new monthly donation amount, enter the amount in the text box and click **Add**. This custom amount will be added to the list of available options. + - **Save Changes**: After configuring the donation settings, click **Save Changes** to apply the updated options. Be sure to save each time you make changes to ensure they are implemented. + +### 4. Country Settings + +- The **Country Settings** section allows you to manage country-specific settings by updating country names as needed. This can be useful if a country name needs correction or a specific format. + - **Select a Country** + - Use the **Countries** dropdown menu to select the country you want to edit. This dropdown lists all countries available in the system. + - Once a country is selected, its current name will appear in the **Selected Country** field below. + - **Update Country Name** + - In the **Update Country Name** field, enter the new name or corrected format for the selected country. + - This feature allows you to ensure consistency and accuracy in country names across the platform. + - **Save Changes** + - After entering the updated country name, click **Save Changes** to apply the modification. Make sure to save each time you update a country to ensure the changes take effect. \ No newline at end of file diff --git a/mint-backup.json b/mint-backup.json new file mode 100644 index 0000000..2799bba --- /dev/null +++ b/mint-backup.json @@ -0,0 +1,91 @@ +{ + "$schema": "https://mintlify.com/schema.json", + "name": "Starter Kit", + "logo": { + "dark": "/logo/dark.svg", + "light": "/logo/light.svg" + }, + "favicon": "/favicon.svg", + "colors": { + "primary": "#0D9373", + "light": "#07C983", + "dark": "#0D9373", + "anchors": { + "from": "#0D9373", + "to": "#07C983" + } + }, + "topbarLinks": [ + { + "name": "Support", + "url": "mailto:hi@mintlify.com" + } + ], + "topbarCtaButton": { + "name": "Dashboard", + "url": "https://dashboard.mintlify.com" + }, + "tabs": [ + { + "name": "API Reference", + "url": "api-reference" + } + ], + "anchors": [ + { + "name": "Documentation", + "icon": "book-open-cover", + "url": "https://mintlify.com/docs" + }, + { + "name": "Community", + "icon": "slack", + "url": "https://mintlify.com/community" + }, + { + "name": "Blog", + "icon": "newspaper", + "url": "https://mintlify.com/blog" + } + ], + "navigation": [ + { + "group": "Get Started", + "pages": [ + "introduction", + "quickstart", + "development" + ] + }, + { + "group": "Essentials", + "pages": [ + "essentials/markdown", + "essentials/code", + "essentials/images", + "essentials/settings", + "essentials/navigation", + "essentials/reusable-snippets" + ] + }, + { + "group": "API Documentation", + "pages": [ + "api-reference/introduction" + ] + }, + { + "group": "Endpoint Examples", + "pages": [ + "api-reference/endpoint/get", + "api-reference/endpoint/create", + "api-reference/endpoint/delete" + ] + } + ], + "footerSocials": { + "x": "https://x.com/mintlify", + "github": "https://github.com/mintlify", + "linkedin": "https://linkedin.com/company/mintlify" + } +} diff --git a/mint.json b/mint.json index 2799bba..4489905 100644 --- a/mint.json +++ b/mint.json @@ -1,6 +1,6 @@ { "$schema": "https://mintlify.com/schema.json", - "name": "Starter Kit", + "name": "Celebrate Mercy", "logo": { "dark": "/logo/dark.svg", "light": "/logo/light.svg" @@ -18,73 +18,105 @@ "topbarLinks": [ { "name": "Support", - "url": "mailto:hi@mintlify.com" + "url": "mailto:hello@aalpha.ai" } ], "topbarCtaButton": { "name": "Dashboard", "url": "https://dashboard.mintlify.com" }, + "primaryTab": { + "name": "Global Salawat Site" + }, "tabs": [ { - "name": "API Reference", - "url": "api-reference" + "name": "Global Salawat Dashboard", + "url": "global-salawat-dashboard" + }, + { + "name": "Development Tools", + "url": "development-tools" } ], "anchors": [ { - "name": "Documentation", + "name": "Global Salawat Site", "icon": "book-open-cover", - "url": "https://mintlify.com/docs" + "url": "https://salawat.celebratemercy.com/" + }, + { + "name": "Global Salawat Dashboard", + "icon": "gauge", + "url": "https://salawat.celebratemercy.com/admin" + }, + { + "name": "Database", + "icon": "database", + "url": "https://supabase.com/dashboard/project/pmzfddqowezjyjzdvipv" + }, + { + "name": "Code", + "icon": "github", + "url": "https://github.com/celebratemercy" }, { - "name": "Community", - "icon": "slack", - "url": "https://mintlify.com/community" + "name": "Deployments", + "icon": "rocket", + "url": "https://vercel.com/developer-celebratemercys-projects" }, { - "name": "Blog", - "icon": "newspaper", - "url": "https://mintlify.com/blog" + "name": "Site Builder", + "icon": "trowel-bricks", + "url": "https://builder.io/content" + }, + { + "name": "User Management", + "icon": "user", + "url": "https://dashboard.clerk.com/apps/app_2kyMDWAA2QqOWtFfk1hkbD2WI1a/instances/ins_2lNdx9suK2wj9GGopBoh0GR3s2F" + }, + { + "name": "Design", + "icon": "droplet", + "url": "https://www.figma.com/files/team/1435910220577978185/recents-and-sharing?fuid=1435910216243670266" } ], "navigation": [ { - "group": "Get Started", - "pages": [ - "introduction", - "quickstart", - "development" - ] - }, - { - "group": "Essentials", + "group": "Getting Started", "pages": [ - "essentials/markdown", - "essentials/code", - "essentials/images", - "essentials/settings", - "essentials/navigation", - "essentials/reusable-snippets" + "global-salawat-challenge/home", + "global-salawat-challenge/global-rankings", + "global-salawat-challenge/organizations" ] }, { - "group": "API Documentation", + "group": "Getting Started", "pages": [ - "api-reference/introduction" + "global-salawat-dashboard/analytics", + "global-salawat-dashboard/pledges", + "global-salawat-dashboard/organizations", + "global-salawat-dashboard/donations", + "global-salawat-dashboard/settings" ] }, { - "group": "Endpoint Examples", + "group": "Getting Started", "pages": [ - "api-reference/endpoint/get", - "api-reference/endpoint/create", - "api-reference/endpoint/delete" + "development-tools/builder", + "development-tools/setup", + "development-tools/local-development", + { + "group": "API Tools", + "pages": [ + "tools/api/authentication", + "tools/api/endpoints", + "tools/api/testing" + ] + } ] } ], "footerSocials": { - "x": "https://x.com/mintlify", "github": "https://github.com/mintlify", "linkedin": "https://linkedin.com/company/mintlify" }