A powerful SaaS documentation platform, available exclusively through EurekaCodes

---

EurekaBox is a powerful SaaS (Software as a Service) documentation platform, available exclusively through EurekaCodes. It provides teams with an intuitive document editor to create, share, and manage documentation efficiently, enabling team members to focus on their work while maintaining clear and accessible documentation.

🌟 Getting Started with EurekaCodes

1. Visit EurekaCodes to subscribe to the service
2. Create your workspace through the EurekaCodes dashboard
3. Start creating your team documentation

Features

• 📝 Rich Document Editor - Create and edit documents with a powerful WYSIWYG editor
• 🗂 Smart Organization - Organize documents with intuitive folder structures and tags
• 🔍 Quick Search - Find documents instantly with powerful search capabilities
• 🔐 Secure Sharing - Control access to your documents with granular permissions

Tech Stack

• Frontend Framework: React with TypeScript
• Project Structure: Nx Monorepo
• State Management: TanStack Query
• Styling: Tailwind CSS
• UI Components: Radix UI
• API Integration: Axios
• Internationalization: i18next

Project Structure

eurekabox-front/
├── apps/
│   └── web/              # Main application entry point
├── libs/
│   ├── web-core/         # Core authentication and initialization
│   ├── ui-kit/           # Shared UI components library
│   ├── contents/         # Document management and content operations
│   ├── shared/           # Utilities and shared logic
│   └── theme/            # Theme management system
├── tools/                # Development scripts and configs
├── nx.json               # `nx.json`
└── package.json          # Workspace package manager configuration

Getting Started

Prerequisites

• Node.js (v20 or higher)
• npm or yarn
• Git

Installation

1. Clone the repository

$ git clone https://github.com/lemoncloud-io/eurekabox-front.git
$ cd eurekabox-front

2. Install dependencies

$ yarn install

3. Set up environment variables

$ cp apps/web/.env.example apps/web/.env.local

4. Start the development server

$ yarn web:start

The application will be available at http://localhost:5001

Contributing

1. Fork the repository
2. Create your feature branch ( git checkout -b feature/amazing-feature )
3. Commit your changes ( git commit -m 'feat: add amazing feature' )
4. Push to the branch ( git push origin feature/amazing-feature )
5. Open a Pull Request

License

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

Acknowledgments

• Built with Nx
• UI components from Radix UI
• Styling with Tailwind CSS

Disclaimer and Risks

This project uses functionalities from external APIs but is not officially affiliated with or endorsed by their providers. Users are responsible for complying with API terms, rate limits, and policies.

---

If this project has been helpful, please consider giving it a Star ⭐️!