diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..4aaa838 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,41 @@ +name: Build and Deploy Docs to AWS S3 + +on: + push: + branches: + - main + paths: + - 'apps/docs/**' + +jobs: + deploy: + runs-on: ubuntu-latest + + steps: + # Step 1: Check out the repository + - name: Checkout code + uses: actions/checkout@v3 + + # Step 2: Set up Node.js + - name: Set up Node.js + uses: actions/setup-node@v3 + with: + node-version: 18 # Use the version matching your project + + # Step 3: Install dependencies and build the app + - name: Install dependencies and build + run: | + npm ci + npm run build + + # Step 4: Configure AWS CLI + - name: Configure AWS CLI + uses: aws-actions/configure-aws-credentials@v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ secrets.AWS_REGION }} + + # Step 5: Upload to S3 + - name: Upload to S3 + run: aws s3 sync ./apps/docs/build s3://docs.bsamaritan.com --delete \ No newline at end of file diff --git a/apps/docs/docs/tutorial-extras/_category_.json b/apps/docs/docs/deployment/_category_.json similarity index 67% rename from apps/docs/docs/tutorial-extras/_category_.json rename to apps/docs/docs/deployment/_category_.json index a8ffcc1..2e589a1 100644 --- a/apps/docs/docs/tutorial-extras/_category_.json +++ b/apps/docs/docs/deployment/_category_.json @@ -1,5 +1,5 @@ { - "label": "Tutorial - Extras", + "label": "Deployment", "position": 3, "link": { "type": "generated-index" diff --git a/apps/docs/docs/tutorial-extras/img/docsVersionDropdown.png b/apps/docs/docs/deployment/img/docsVersionDropdown.png similarity index 100% rename from apps/docs/docs/tutorial-extras/img/docsVersionDropdown.png rename to apps/docs/docs/deployment/img/docsVersionDropdown.png diff --git a/apps/docs/docs/tutorial-extras/img/localeDropdown.png b/apps/docs/docs/deployment/img/localeDropdown.png similarity index 100% rename from apps/docs/docs/tutorial-extras/img/localeDropdown.png rename to apps/docs/docs/deployment/img/localeDropdown.png diff --git a/apps/docs/docs/tutorial-extras/manage-docs-versions.md b/apps/docs/docs/deployment/manage-docs-versions.md similarity index 100% rename from apps/docs/docs/tutorial-extras/manage-docs-versions.md rename to apps/docs/docs/deployment/manage-docs-versions.md diff --git a/apps/docs/docs/tutorial-extras/translate-your-site.md b/apps/docs/docs/deployment/translate-your-site.md similarity index 100% rename from apps/docs/docs/tutorial-extras/translate-your-site.md rename to apps/docs/docs/deployment/translate-your-site.md diff --git a/apps/docs/docs/faqs.md b/apps/docs/docs/faqs.md new file mode 100644 index 0000000..233292b --- /dev/null +++ b/apps/docs/docs/faqs.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 5 +--- + +# FAQs diff --git a/apps/docs/docs/getting-started/Get Credentials/_category_.json b/apps/docs/docs/getting-started/Get Credentials/_category_.json new file mode 100644 index 0000000..5d7d8c8 --- /dev/null +++ b/apps/docs/docs/getting-started/Get Credentials/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Getting Credentials", + "position": 2, + "link": { + "type": "generated-index", + "description": "Getting API Keys or OAuth Credentials for the third party connections." + } +} diff --git a/apps/docs/docs/getting-started/Get Credentials/google-drive.md b/apps/docs/docs/getting-started/Get Credentials/google-drive.md new file mode 100644 index 0000000..e69de29 diff --git a/apps/docs/docs/getting-started/Get Credentials/notion.md b/apps/docs/docs/getting-started/Get Credentials/notion.md new file mode 100644 index 0000000..e69de29 diff --git a/apps/docs/docs/getting-started/Get Credentials/openai.md b/apps/docs/docs/getting-started/Get Credentials/openai.md new file mode 100644 index 0000000..e69de29 diff --git a/apps/docs/docs/getting-started/Get Credentials/youtube.md b/apps/docs/docs/getting-started/Get Credentials/youtube.md new file mode 100644 index 0000000..e69de29 diff --git a/apps/docs/docs/getting-started/_category_.json b/apps/docs/docs/getting-started/_category_.json new file mode 100644 index 0000000..cf754da --- /dev/null +++ b/apps/docs/docs/getting-started/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "Getting Started", + "position": 2, + "link": { + "type": "generated-index", + "description": "In this section, we'll guide you through the initial steps to get started with deploying the application locally. Before you dive into the specifics, make sure you meet the system requirements and have everything in place." + } +} diff --git a/apps/docs/docs/tutorial-basics/congratulations.md b/apps/docs/docs/getting-started/congratulations.md similarity index 100% rename from apps/docs/docs/tutorial-basics/congratulations.md rename to apps/docs/docs/getting-started/congratulations.md diff --git a/apps/docs/docs/tutorial-basics/create-a-blog-post.md b/apps/docs/docs/getting-started/create-a-blog-post.md similarity index 100% rename from apps/docs/docs/tutorial-basics/create-a-blog-post.md rename to apps/docs/docs/getting-started/create-a-blog-post.md diff --git a/apps/docs/docs/tutorial-basics/create-a-document.md b/apps/docs/docs/getting-started/create-a-document.md similarity index 100% rename from apps/docs/docs/tutorial-basics/create-a-document.md rename to apps/docs/docs/getting-started/create-a-document.md diff --git a/apps/docs/docs/tutorial-basics/deploy-your-site.md b/apps/docs/docs/getting-started/deploy-your-site.md similarity index 100% rename from apps/docs/docs/tutorial-basics/deploy-your-site.md rename to apps/docs/docs/getting-started/deploy-your-site.md diff --git a/apps/docs/docs/tutorial-basics/markdown-features.mdx b/apps/docs/docs/getting-started/markdown-features.mdx similarity index 100% rename from apps/docs/docs/tutorial-basics/markdown-features.mdx rename to apps/docs/docs/getting-started/markdown-features.mdx diff --git a/apps/docs/docs/getting-started/requirements.md b/apps/docs/docs/getting-started/requirements.md new file mode 100644 index 0000000..de52d37 --- /dev/null +++ b/apps/docs/docs/getting-started/requirements.md @@ -0,0 +1,63 @@ +--- +sidebar_position: 1 +--- + +# Requirements + +## Public Site + +- Any Browser + +## Using Locally in Dev Mode + +- python >= 3.8 + ``` bash + # Check Availability and Version + python + ``` + Download using this site https://www.python.org/downloads/ + +- node >= 21.7.3 + ``` bash + # Check Availability and Version + node -v + ``` + Download using this site https://docs.npmjs.com/downloading-and-installing-node-js-and-npm + +- npm >= 10.5.0 + ``` bash + # Check Availability and Version + npm -v + ``` + Download using this site https://docs.npmjs.com/downloading-and-installing-node-js-and-npm + +- git + ``` bash + # Check Availability + git + ``` + Download using this site https://git-scm.com/downloads + +## Using Locally using Docker Compose + +- docker >= 27.1.1 + ``` bash + # Check Availability and Version + docker -v + ``` + Download using this site https://www.docker.com/products/docker-desktop/ + + +- docker-compose >= 1.29.2 + ``` bash + # Check Availability and Version + docker-compose -v + ``` + Download using this site https://docs.docker.com/compose/install + +- git + ``` bash + # Check Availability + git + ``` + Download using this site https://git-scm.com/downloads \ No newline at end of file diff --git a/apps/docs/docs/intro.md b/apps/docs/docs/intro.md deleted file mode 100644 index 45e8604..0000000 --- a/apps/docs/docs/intro.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Tutorial Intro - -Let's discover **Docusaurus in less than 5 minutes**. - -## Getting Started - -Get started by **creating a new site**. - -Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**. - -### What you'll need - -- [Node.js](https://nodejs.org/en/download/) version 18.0 or above: - - When installing Node.js, you are recommended to check all checkboxes related to dependencies. - -## Generate a new site - -Generate a new Docusaurus site using the **classic template**. - -The classic template will automatically be added to your project after you run the command: - -```bash -npm init docusaurus@latest my-website classic -``` - -You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor. - -The command also installs all necessary dependencies you need to run Docusaurus. - -## Start your site - -Run the development server: - -```bash -cd my-website -npm run start -``` - -The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there. - -The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/. - -Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes. diff --git a/apps/docs/docs/overview.md b/apps/docs/docs/overview.md new file mode 100644 index 0000000..0d0ec86 --- /dev/null +++ b/apps/docs/docs/overview.md @@ -0,0 +1,34 @@ +--- +sidebar_position: 1 +--- + +# Overview + +CASY (Code Automation System) is a open source semi code automation solution to automate every aspect of your life with sample code generation and public workflows with third party connections like Notion, Open AI, Youtube and Google Drive using the above boilerplate. + +## Key Features + +CASY comes with a fully customizable features that cater to a diverse set of users. Here are some of the key features: + +* **Automations**: Create Automations by creating series of trigger and actions of multiple code blocks. +* **Sample Code Generation**: Generate Code Blocks related to third party api calls to Notion, OpenAI, Youtube, Google Drive, etc. +* **Notion Systems**: Links of Notion Pages which can be duplicated with different Systems to gamify all aspect of your life. +* **Third Party Connections**: OAuth and API key connections with lot of third party apps. + +## Who Should Use This Documentation + +This documentation is intended for: + +* **New Users**: If you're new to CASY, this guide will help you get started, set up your account, and begin using the application effectively. +* **Experienced Users**: If you're already familiar with our application, this documentation serves as a valuable resource for advanced configurations, best practices, and troubleshooting. + +## How to Use This Documentation + +* **Search**: Use the search bar to quickly find information on specific topics. +* **Navigation**:The documentation is organized into sections, so you can navigate through the table of contents to locate the information you need. +* **Links**: We've included links to related articles and resources for in-depth exploration. +* **Feedback**: If you can't find the information you're looking for or have suggestions for improvement, please let us know. + +## Contacting Support + +If you encounter any issues or have questions not covered in this documentation, our dedicated support team is here to assist you. Contact us at *danoopkarnik@gmail.com*. \ No newline at end of file diff --git a/apps/docs/docs/troubleshooting.md b/apps/docs/docs/troubleshooting.md new file mode 100644 index 0000000..5e7f0cc --- /dev/null +++ b/apps/docs/docs/troubleshooting.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 4 +--- + +# Troubleshooting diff --git a/apps/docs/docs/tutorial-basics/_category_.json b/apps/docs/docs/tutorial-basics/_category_.json deleted file mode 100644 index 2e6db55..0000000 --- a/apps/docs/docs/tutorial-basics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Tutorial - Basics", - "position": 2, - "link": { - "type": "generated-index", - "description": "5 minutes to learn the most important Docusaurus concepts." - } -} diff --git a/apps/docs/docs/tutorial-basics/create-a-page.md b/apps/docs/docs/tutorial-basics/create-a-page.md deleted file mode 100644 index 20e2ac3..0000000 --- a/apps/docs/docs/tutorial-basics/create-a-page.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Create a Page - -Add **Markdown or React** files to `src/pages` to create a **standalone page**: - -- `src/pages/index.js` → `localhost:3000/` -- `src/pages/foo.md` → `localhost:3000/foo` -- `src/pages/foo/bar.js` → `localhost:3000/foo/bar` - -## Create your first React Page - -Create a file at `src/pages/my-react-page.js`: - -```jsx title="src/pages/my-react-page.js" -import React from 'react'; -import Layout from '@theme/Layout'; - -export default function MyReactPage() { - return ( - -

My React page

-

This is a React page

- - ); -} -``` - -A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page). - -## Create your first Markdown Page - -Create a file at `src/pages/my-markdown-page.md`: - -```mdx title="src/pages/my-markdown-page.md" -# My Markdown page - -This is a Markdown page -``` - -A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page). diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts index c305860..0f0aa49 100644 --- a/apps/docs/docusaurus.config.ts +++ b/apps/docs/docusaurus.config.ts @@ -96,7 +96,7 @@ const config: Config = { items: [ { label: 'Tutorial', - to: '/docs/intro', + to: '/docs/overview', }, ], }, diff --git a/apps/docs/src/components/HomepageFeatures/index.tsx b/apps/docs/src/components/HomepageFeatures/index.tsx index 27bbc4b..11a5568 100644 --- a/apps/docs/src/components/HomepageFeatures/index.tsx +++ b/apps/docs/src/components/HomepageFeatures/index.tsx @@ -51,7 +51,7 @@ function Feature({title, path, description}: FeatureItem) { return (
- {title} + {title}
{title} diff --git a/apps/docs/static/img/automations.png b/apps/docs/static/img/automations.png new file mode 100644 index 0000000..cc9a35d Binary files /dev/null and b/apps/docs/static/img/automations.png differ diff --git a/apps/docs/static/img/notion_systems.png b/apps/docs/static/img/notion_systems.png index a763b36..3c42286 100644 Binary files a/apps/docs/static/img/notion_systems.png and b/apps/docs/static/img/notion_systems.png differ diff --git a/apps/docs/static/img/sample_code_generation.png b/apps/docs/static/img/sample_code_generation.png new file mode 100644 index 0000000..cbb1154 Binary files /dev/null and b/apps/docs/static/img/sample_code_generation.png differ diff --git a/apps/docs/static/img/third_party_connections.png b/apps/docs/static/img/third_party_connections.png new file mode 100644 index 0000000..1972ec2 Binary files /dev/null and b/apps/docs/static/img/third_party_connections.png differ diff --git a/package.json b/package.json index 762caed..b9845fe 100644 --- a/package.json +++ b/package.json @@ -8,6 +8,7 @@ "format": "prettier --write \"**/*.{ts,tsx,md}\"", "db:migrate": "cd packages/prisma-db && npx prisma migrate dev --name init", "db:generate": "cd packages/prisma-db && npx prisma generate", + "build-docs": "cd ./apps/docs && npm ci && npm run build", "build-dashboard-app": "cd ./apps/dashboard-app && npm run build", "start-dashboard-app": "cd ./apps/dashboard-app && npm run start", "start-scheduler": "cd ./apps/scheduler && npm run dev",