FreeChatium

A Serverless Edge AI Workspace with Puter.js zero-key client engine, OpenRouter 100+ models, multi-modal vision, live sandboxed code execution, and cloud storage.

FreeChatium is a Next.js application that provides an interactive, accessible, and fast AI workspace. Powered by Puter.js and OpenRouter, it offers access to over 100 AI models (including Claude 3.5, GPT-4o, DeepSeek V3, and Mistral Large), robust sandboxed code execution, and seamless cloud storage capabilities.

🚀 Getting Started

Prerequisites

• Node.js 20.x or higher
• pnpm 9.0.0 or higher

Installation

1. Clone the repository:

   git clone https://github.com/BleckWolf25/FreeChatium.git
   cd FreeChatium

2. Install dependencies:

   pnpm install

3. Run the development server:

   pnpm run dev

4. Open http://localhost:3000 with your browser to see the result.

📝 Available Scripts

• pnpm dev - Start the Next.js development server
• pnpm build - Compile the production application and export it as static files
• pnpm start - Start the production build locally
• pnpm lint - Run ESLint on the codebase
• pnpm lint:fix - Run ESLint and automatically fix issues
• pnpm test - Run unit and integration tests using Vitest
• pnpm test:e2e - Run end-to-end integration tests using Playwright
• pnpm format - Run Prettier to format the codebase
• pnpm format:check - Check formatting without making modifications
• pnpm typecheck - Run TypeScript compiler check
• pnpm validate - Run all checks, linting, formatting, and tests

🏗️ Project Structure

FreeChatium/
├── .next/               # Next.js build output (generated)
├── public/              # Static public assets (icons, PWA manifest, etc.)
├── scripts/             # Utility and automation scripts (e.g., generate-icons)
├── app/                 # App Router layout, pages, and metadata
├── components/          # React UI components (shadcn/ui style, providers, etc.)
├── lib/                 # Shared library functions & utilities
├── package.json
├── tsconfig.json        # TypeScript configuration
├── tailwind.config.ts   # Tailwind CSS configuration
└── eslint.config.ts     # ESLint configuration

🧪 Testing

The project uses Vitest for unit/integration tests and Playwright for browser e2e testing.

Run Unit Tests

pnpm test

Run End-to-End Tests

pnpm test:e2e

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting a pull request.

By participating in this project, you agree to abide by our Code of Conduct.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔒 Security

For security concerns, please review our Security Policy.

📧 Contact

For questions or support, please open an issue on GitHub or contact joao.coutinho08@gmail.com.

---

Built with ❤️ using Next.js, React, Tailwind CSS, shadcn/ui, TypeScript, Puter.js, and OpenRouter