From a83aae7ee6a71885fb660627e2e2c1bd9b9a2c57 Mon Sep 17 00:00:00 2001 From: Shaurya Date: Wed, 18 Dec 2024 16:38:38 +0400 Subject: [PATCH 1/6] Readme Update --- README.md | 198 ++++++++++++++++++++++++++++++++++----------- apps/www/README.md | 1 - 2 files changed, 149 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index 7a4658a..b396d61 100644 --- a/README.md +++ b/README.md @@ -1,81 +1,181 @@ -# Turborepo starter +# Plura πŸ§ πŸ€– -This is an official starter Turborepo. +![Plura Logo](/apps/www/public/images/plura-logo.png) -## Using this example +## πŸš€ Introduction -Run the following command: +Plura is a revolutionary SaaS platform that redefines AI-powered communication and interaction. Our innovative solution allows you to create intelligent "brains" - custom AI agents that can be trained with specific information and connected across multiple communication channels. -```sh -npx create-turbo@latest -``` +## 🌈 Powered by Turborepo + +### Why Turborepo? + +Plura leverages Turborepo to create a cutting-edge, highly efficient monorepo architecture that provides: -## What's inside? +- **Unprecedented Build Speed**: Turborepo's intelligent caching reduces build and development times +- **Consistent Tooling**: Unified configurations across all project packages +- **Scalable Architecture**: Easy management of multiple applications and shared components +- **Remote Caching**: Efficient build artifact sharing across development and CI/CD environments -This Turborepo includes the following packages/apps: +### Monorepo Structure -### Apps and Packages +Our project is organized into multiple packages and applications: -- `docs`: a [Next.js](https://nextjs.org/) app -- `web`: another [Next.js](https://nextjs.org/) app -- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications -- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`) -- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo +- `apps/web`: Main Plura web application +- `apps/docs`: Documentation site +- `packages/ui`: Shared React component library +- `packages/eslint-config`: Standardized linting configurations +- `packages/typescript-config`: Centralized TypeScript configurations +- `packages/ai-brain`: Core AI brain logic and utilities +- `packages/integrations`: Communication channel connectors -Each package/app is 100% [TypeScript](https://www.typescriptlang.org/). +## 🌟 Core Vision -### Utilities +Plura empowers businesses and individuals to create intelligent, context-aware AI agents that can seamlessly interact across various platforms, breaking down communication barriers and providing personalized, intelligent responses. -This Turborepo has some additional tools already setup for you: +## πŸ”‘ Key Features -- [TypeScript](https://www.typescriptlang.org/) for static type checking -- [ESLint](https://eslint.org/) for code linting -- [Prettier](https://prettier.io) for code formatting +### 🧠 Intelligent AI Brain Creation +- **Custom AI Training**: Easily teach your AI agents with specific, tailored information +- **Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, Instagram, and more +- **Contextual Learning**: Continuously improve agent intelligence based on interactions +- **Flexible Integration**: Seamless connection between brains and communication channels -### Build +### πŸ€– Agent Capabilities +- **Adaptive Communication**: Agents that understand and respond with context +- **Cross-Platform Deployment**: Deploy a single brain across multiple communication platforms +- **Customizable Personality**: Define unique traits and communication styles for each agent +- **Real-time Information Processing**: Instantaneous response generation -To build all apps and packages, run the following command: +## πŸ— System Architecture +```mermaid +graph TD + A[Turborepo Monorepo] --> B[Web Application] + A --> C[Documentation] + A --> D[Shared UI Components] + A --> E[AI Brain Logic] + + B --> F[Agent Creation Interface] + B --> G[Integration Management] + + E --> H[AI Training Module] + E --> I[Multi-Channel Connectors] ``` -cd my-turborepo -pnpm build + +## πŸ’» Tech Stack + +### Frontend +- Next.js 14 +- React 18 +- TypeScript +- Turborepo +- Tailwind CSS +- Shadcn UI +- Zustand (State Management) + +### Backend +- Node.js +- NestJS +- GraphQL +- PostgreSQL +- Redis +- Prisma ORM + +### DevOps & Infrastructure +- Vercel +- GitHub Actions +- Turborepo Remote Caching + +## πŸš€ Getting Started + +### Prerequisites +- Node.js (v19+) +- PNPM +- Docker (optional) + +### Installation & Setup + +1. Clone the repository +```bash +git clone https://github.com/your-org/plura.git +cd plura ``` -### Develop +2. Install dependencies +```bash +pnpm install +``` + +3. Run the entire monorepo +```bash +# Run all applications in development mode +pnpm dev -To develop all apps and packages, run the following command: +# Build all applications +pnpm build +# Run specific application +pnpm dev --filter web ``` -cd my-turborepo -pnpm dev + +## πŸ” Turborepo Configuration + +Our `turbo.json` enables powerful monorepo capabilities: +- Efficient task running +- Intelligent caching +- Parallel execution +- Remote caching support + +### Example Turbo Task +```json +{ + "$schema": "https://turbo.build/schema.json", + "pipeline": { + "build": { + "outputs": ["dist/**", ".next/**"], + "dependsOn": ["^build"] + }, + "lint": {}, + "dev": { + "cache": false + } + } +} ``` -### Remote Caching +## πŸ“¦ Deployment -Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines. +### Vercel Deployment +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fyour-org%2Fplura) -By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup), then enter the following commands: +## 🀝 Contributing -``` -cd my-turborepo -npx turbo login -``` +We welcome contributions to our Turborepo-powered platform! -This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview). +### Contribution Guidelines +1. Understand our monorepo structure +2. Use PNPM workspaces +3. Leverage Turborepo for efficient development +4. Maintain shared configurations +5. Write comprehensive tests -Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo: +## πŸ“Š Roadmap -``` -npx turbo link -``` +- [x] Turborepo Monorepo Setup +- [x] Core Platform MVP +- [ ] Enhanced AI Training Modules +- [ ] Expanded Communication Channel Integrations +- [ ] Advanced Analytics for Agent Performance + +## πŸ“„ Licensing + +Distributed under the MIT License. -## Useful Links +## πŸ“ž Contact -Learn more about the power of Turborepo: +- Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) +- Discord: [Discord](https://discord.gg/plura) +--- -- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks) -- [Caching](https://turbo.build/repo/docs/core-concepts/caching) -- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) -- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering) -- [Configuration Options](https://turbo.build/repo/docs/reference/configuration) -- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference) +**Engineered with πŸš€ Turborepo & ❀️ by the Plura Team** \ No newline at end of file diff --git a/apps/www/README.md b/apps/www/README.md index 4d7a5dc..4b76fca 100644 --- a/apps/www/README.md +++ b/apps/www/README.md @@ -49,7 +49,6 @@ To set up your environment for the project, follow these steps: - Access your application at [Upastash](http://localhost:3001/api/health). ## Need Help? - - Check our [Contributing Guide](../../CONTRIBUTING.md) - Join our [Discord Community](https://discord.gg/XtybuwJV) From 9596f3bc0ff6d678aac0f6c2494b07d7e2aa0c6a Mon Sep 17 00:00:00 2001 From: Shaurya Date: Fri, 20 Dec 2024 23:43:52 +0400 Subject: [PATCH 2/6] Update readme --- README.md | 178 +++++++++--------------------------------------------- 1 file changed, 27 insertions(+), 151 deletions(-) diff --git a/README.md b/README.md index b396d61..89fd761 100644 --- a/README.md +++ b/README.md @@ -1,172 +1,42 @@ -# Plura πŸ§ πŸ€– +# Plura ![Plura Logo](/apps/www/public/images/plura-logo.png) -## πŸš€ Introduction +## πŸ‘€ What is this? -Plura is a revolutionary SaaS platform that redefines AI-powered communication and interaction. Our innovative solution allows you to create intelligent "brains" - custom AI agents that can be trained with specific information and connected across multiple communication channels. +Plura is a SaaS platform that redefines AI-powered communication and interaction. Our innovative solution allows you to create intelligent "brains" - custom AI agents that can be trained with specific information and connected across multiple communication channels. -## 🌈 Powered by Turborepo - -### Why Turborepo? - -Plura leverages Turborepo to create a cutting-edge, highly efficient monorepo architecture that provides: - -- **Unprecedented Build Speed**: Turborepo's intelligent caching reduces build and development times -- **Consistent Tooling**: Unified configurations across all project packages -- **Scalable Architecture**: Easy management of multiple applications and shared components -- **Remote Caching**: Efficient build artifact sharing across development and CI/CD environments - -### Monorepo Structure - -Our project is organized into multiple packages and applications: - -- `apps/web`: Main Plura web application -- `apps/docs`: Documentation site -- `packages/ui`: Shared React component library -- `packages/eslint-config`: Standardized linting configurations -- `packages/typescript-config`: Centralized TypeScript configurations -- `packages/ai-brain`: Core AI brain logic and utilities -- `packages/integrations`: Communication channel connectors - -## 🌟 Core Vision - -Plura empowers businesses and individuals to create intelligent, context-aware AI agents that can seamlessly interact across various platforms, breaking down communication barriers and providing personalized, intelligent responses. +### 🫣Whats inside? + Coming soon ## πŸ”‘ Key Features +- πŸ”—**Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, Instagram, and more +- 🧠**Custom AI Training**: Easily teach your AI agents with specific, information +- πŸ’¬ **Chat with Collections**: Interact with specific knowledge bases. +- πŸ” **Powerful Search**: Quickly find any saved information. +- 🏠 **Self Hostable**: Open source and easy to deploy locally. -### 🧠 Intelligent AI Brain Creation -- **Custom AI Training**: Easily teach your AI agents with specific, tailored information -- **Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, Instagram, and more -- **Contextual Learning**: Continuously improve agent intelligence based on interactions -- **Flexible Integration**: Seamless connection between brains and communication channels - -### πŸ€– Agent Capabilities -- **Adaptive Communication**: Agents that understand and respond with context -- **Cross-Platform Deployment**: Deploy a single brain across multiple communication platforms -- **Customizable Personality**: Define unique traits and communication styles for each agent -- **Real-time Information Processing**: Instantaneous response generation ## πŸ— System Architecture -```mermaid -graph TD - A[Turborepo Monorepo] --> B[Web Application] - A --> C[Documentation] - A --> D[Shared UI Components] - A --> E[AI Brain Logic] - - B --> F[Agent Creation Interface] - B --> G[Integration Management] - - E --> H[AI Training Module] - E --> I[Multi-Channel Connectors] -``` +-Coming soon ## πŸ’» Tech Stack -### Frontend -- Next.js 14 -- React 18 -- TypeScript -- Turborepo -- Tailwind CSS -- Shadcn UI -- Zustand (State Management) - -### Backend -- Node.js -- NestJS -- GraphQL -- PostgreSQL -- Redis -- Prisma ORM - -### DevOps & Infrastructure -- Vercel -- GitHub Actions -- Turborepo Remote Caching - -## πŸš€ Getting Started - -### Prerequisites -- Node.js (v19+) -- PNPM -- Docker (optional) - -### Installation & Setup - -1. Clone the repository -```bash -git clone https://github.com/your-org/plura.git -cd plura -``` - -2. Install dependencies -```bash -pnpm install -``` - -3. Run the entire monorepo -```bash -# Run all applications in development mode -pnpm dev - -# Build all applications -pnpm build - -# Run specific application -pnpm dev --filter web -``` - -## πŸ” Turborepo Configuration - -Our `turbo.json` enables powerful monorepo capabilities: -- Efficient task running -- Intelligent caching -- Parallel execution -- Remote caching support - -### Example Turbo Task -```json -{ - "$schema": "https://turbo.build/schema.json", - "pipeline": { - "build": { - "outputs": ["dist/**", ".next/**"], - "dependsOn": ["^build"] - }, - "lint": {}, - "dev": { - "cache": false - } - } -} -``` - -## πŸ“¦ Deployment - -### Vercel Deployment -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fyour-org%2Fplura) +
+Plura +
-## 🀝 Contributing -We welcome contributions to our Turborepo-powered platform! +## 🀝 Contributing +Contributions are very welcome! A contribution can be as small as a ⭐ or even finding and creating issues. -### Contribution Guidelines -1. Understand our monorepo structure -2. Use PNPM workspaces -3. Leverage Turborepo for efficient development -4. Maintain shared configurations -5. Write comprehensive tests +- for joining our community, please Contact [Saidev Dhal](https://github.com/Skidgod4444/) +- for contributing to our code, please follow the contribution guidelines below -## πŸ“Š Roadmap +### Contribution Guidelines +- Go check out [Contributing.md](https://github.com/SkidGod4444/plura/blob/main/CONTRIBUTING.md) -- [x] Turborepo Monorepo Setup -- [x] Core Platform MVP -- [ ] Enhanced AI Training Modules -- [ ] Expanded Communication Channel Integrations -- [ ] Advanced Analytics for Agent Performance ## πŸ“„ Licensing @@ -178,4 +48,10 @@ Distributed under the MIT License. - Discord: [Discord](https://discord.gg/plura) --- -**Engineered with πŸš€ Turborepo & ❀️ by the Plura Team** \ No newline at end of file +### Contributing + + + + + +**Engineered with ❀️ by the Plura Team** \ No newline at end of file From ff121eae9141a7052f267c065c633678bd2992b6 Mon Sep 17 00:00:00 2001 From: Shaurya Date: Sat, 21 Dec 2024 00:13:18 +0400 Subject: [PATCH 3/6] Update all Raedme --- CONTRIBUTING.md | 57 ++++++++++++++++------------------------------ README.md | 5 +--- apps/api/README.md | 14 ++++++++++-- apps/www/README.md | 16 ++++++++++--- 4 files changed, 46 insertions(+), 46 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 472dfbf..627e676 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,9 @@ +![Plura Logo](/apps/www/public/images/plura-logo.png) + # Contributing -When contributing to this repository, please first discuss the change you wish to make via issue, -email, or any other method with the owners of this repository before making a change. +When contributing to this repository, please first search throught the issues in the repository and commit "assign me" if you wish to work on that , +then owners of this repository will let you know by latest by assigning you the issue. Please note we have a code of conduct, please follow it in all your interactions with the project. @@ -35,47 +37,28 @@ Please note we have a code of conduct, please follow it in all your interactions 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you. -## Code of Conduct - -### Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, gender identity and expression, level of experience, -nationality, personal appearance, race, religion, or sexual identity and -orientation. - -### Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members - -Examples of unacceptable behavior by participants include: - -* The use of sexualized language or imagery and unwelcome sexual attention or -advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic - address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting ### Our Responsibilities -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +Project owners are responsible for taking care of the repository and guiding you +to the right way. So please follow to what they say and do in there command Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## πŸ“ž Contact + +- Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) +- Discord: [Discord](https://discord.gg/plura) +--- + +### Contributing + + + + + +**Engineered with ❀️ by the Plura Team** \ No newline at end of file diff --git a/README.md b/README.md index 89fd761..119108e 100644 --- a/README.md +++ b/README.md @@ -23,10 +23,7 @@ Plura is a SaaS platform that redefines AI-powered communication and interaction ## πŸ’» Tech Stack -
-Plura -
- +Coming soon ## 🀝 Contributing Contributions are very welcome! A contribution can be as small as a ⭐ or even finding and creating issues. diff --git a/apps/api/README.md b/apps/api/README.md index caa1277..497d1fb 100644 --- a/apps/api/README.md +++ b/apps/api/README.md @@ -51,6 +51,16 @@ UPSTASH_REDIS_REST_TOKEN= UPSTASH_REDIS_REST_URL= ``` -## License +## πŸ“ž Contact -Copyright 2024 Plura. \ No newline at end of file +- Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) +- Discord: [Discord](https://discord.gg/plura) +--- + +### Contributing + + + + + +**Engineered with ❀️ by the Plura Team** \ No newline at end of file diff --git a/apps/www/README.md b/apps/www/README.md index 7a7e31a..331c709 100644 --- a/apps/www/README.md +++ b/apps/www/README.md @@ -46,7 +46,17 @@ To set up your environment for the project, follow these steps: - Access your application at [Upastash](http://localhost:3001/api/health). -## Need Help? -- Check our [Contributing Guide](../../CONTRIBUTING.md) -- Join our [Discord Community](https://discord.gg/XtybuwJV) +## πŸ“ž Contact + +- Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) +- Discord: [Discord](https://discord.gg/plura) +--- + +### Contributing + + + + + +**Engineered with ❀️ by the Plura Team** From dc72e4ab8e71c49bbdd8b0f2573bfbde68a32ba7 Mon Sep 17 00:00:00 2001 From: Shaurya Bahl <105645937+osh0612@users.noreply.github.com> Date: Sat, 21 Dec 2024 00:15:15 +0400 Subject: [PATCH 4/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 627e676..c9d1419 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ # Contributing -When contributing to this repository, please first search throught the issues in the repository and commit "assign me" if you wish to work on that , +When contributing to this repository, please first search through the issues in the repository and commit "assign me" if you wish to work on that , then owners of this repository will let you know by latest by assigning you the issue. Please note we have a code of conduct, please follow it in all your interactions with the project. @@ -61,4 +61,4 @@ threatening, offensive, or harmful. -**Engineered with ❀️ by the Plura Team** \ No newline at end of file +**Engineered with ❀️ by the Plura Team** From 9e5fabe00883cdae496a85aa6cbd43e3ffb7ae41 Mon Sep 17 00:00:00 2001 From: Shaurya Bahl <105645937+osh0612@users.noreply.github.com> Date: Sat, 21 Dec 2024 11:28:44 +0400 Subject: [PATCH 5/6] Update CONTRIBUTING.md --- CONTRIBUTING.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c9d1419..b809659 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,8 +40,12 @@ Please note we have a code of conduct, please follow it in all your interactions ### Our Responsibilities -Project owners are responsible for taking care of the repository and guiding you -to the right way. So please follow to what they say and do in there command +Project maintainers are responsible for: +- Providing guidance to contributors +- Maintaining repository quality and standards +- Setting clear expectations for contributions + +Contributors are expected to follow maintainer guidance and project guidelines. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions From ef6973742b6058f079dbfcd525a41590189c8786 Mon Sep 17 00:00:00 2001 From: "Saidev Dhal (Dev)" Date: Sun, 22 Dec 2024 20:29:40 +0530 Subject: [PATCH 6/6] Update README.md core: relevant changes --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 119108e..41045ac 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,15 @@ Plura is a SaaS platform that redefines AI-powered communication and interaction Coming soon ## πŸ”‘ Key Features -- πŸ”—**Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, Instagram, and more +- πŸ”—**Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, and more - 🧠**Custom AI Training**: Easily teach your AI agents with specific, information - πŸ’¬ **Chat with Collections**: Interact with specific knowledge bases. -- πŸ” **Powerful Search**: Quickly find any saved information. - 🏠 **Self Hostable**: Open source and easy to deploy locally. ## πŸ— System Architecture --Coming soon +Coming soon ## πŸ’» Tech Stack @@ -28,7 +27,7 @@ Coming soon ## 🀝 Contributing Contributions are very welcome! A contribution can be as small as a ⭐ or even finding and creating issues. -- for joining our community, please Contact [Saidev Dhal](https://github.com/Skidgod4444/) +- for joining our community, please Contact [Saidev Dhal](https://cal.com/saidevdhal) - for contributing to our code, please follow the contribution guidelines below ### Contribution Guidelines @@ -41,8 +40,8 @@ Distributed under the MIT License. ## πŸ“ž Contact -- Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) -- Discord: [Discord](https://discord.gg/plura) +- Mail: [connect.saidev@gmail.com](mailto:connect.saidev@gmail.com) +- Discord: [Discord](https://l.devwtf.in/plura-dc) --- ### Contributing @@ -51,4 +50,4 @@ Distributed under the MIT License. -**Engineered with ❀️ by the Plura Team** \ No newline at end of file +**Engineered with ❀️ by the Plura Team**