README.md

PINAC Workspace

A privacy-first, cross-platform, open-source desktop AI assistant for all

One Next-Gen AI Chat for all your needs.

PINAC Workspace is a modern-looking privacy-first AI chat for desktops, seamlessly blending Electron and React for a modern user experience. Unlock the full potential of AI with unparalleled simplicity and user-friendliness, while enjoying ultimate freedom and privacy.

Why PINAC Workspace ?

PINAC Workspace simplifies AI use for everyone, allowing users to get high-quality results without complex prompts. Our easy-to-use beautiful desktop app allows you to express your needs in simple language and it applies the expert-level prompt on top of it after identifying the user's specific requirement so that users receive optimal outcomes. This empowers users to tap into powerful AI capabilities, saving time and boosting creativity across various fields.

🎨 App Interface

Introducing our distraction-free, user-friendly app interface with three stunning themes. It is designed to help you stay focused and productive. it comes with three themes,

📂 File Structure

Overview of File Structure in Brief to Help You Get Started.

.
├── public /
├── index.html
|
├── electron /
|    ├── main.ts
|    ├── preload.ts
|    ├── prompts.ts
|    └── model /
|
└── src /
     ├── App.tsx
     ├── App.css           # All element's colors theme-wise
     ├── database /
     |    └── db.ts
     |
     ├── components /      # common components
     |    ├── styles /
     |    ├── MarkdownStyle.tsx
     |    ├── Menubar.tsx
     |    ├── Sidebar.tsx
     |    └── ThemeToggle.tsx
     |
     ├── context /
     |    ├── StopTextGeneration.ts
     |    ├── SubPage.tsx
     |    ├── ThemeMode.tsx
     |    └── ThemeStyle.tsx
     |
     ├── features /
     |    ├── aboutUs /
     |    ├── authentication /
     |    ├── header /
     |    ├── inputPanel /
     |    ├── msgBubble /
     |    ├── profile /
     |    ├── settings /
     |    ├── authentication /
     |    └── welcomeText /
     |
     └── pages /
          ├── styles /
          ├── Home.tsx
          └── Login.tsx

🚀 Getting Started

Tip

If you are facing any problem with authentication, you can switch to branch minimal-version to use the app without authentication(it uses development server), provided for testing ui.

1. Clone the Repository

   git clone https://github.com/pinacai/PINAC_Workspace.git && cd PINAC_Workspace

2. Install Node dependencies

   npm install

3. Start the App

   npm run dev

🎉 Contributing

We highly welcome contributions! Please follow the steps if you're interested.

1. Star the repository
2. Fork the repository on GitHub.
3. Clone the project to your machine.
4. create you own branch.
5. Commit changes to your branch.
6. Push your work back up to your fork.
7. Submit a Pull request so that we can review your changes

📄 License

PINAC Workspace is licensed under the GPL-3.0 license. See the LICENSE file for more details.

🌏 Contributors

Thanks to our contributors, we have received huge support from the open-source community.

📢 Announcement

We are also building the website for PINAC Workspace along with this app, where we are developing the backend api endpoints in it. If you want to contribute to it visit our repository PINAC Web