Core

🚀 OpenSumi

OpenSumi is an open - source project that welcomes developers to contribute and build together, providing a rich set of development tools and components.

🚀 Quick Start

📦 Installation

# Clone the repository
git clone https://github.com/opensumi/core.git

# Navigate to the project directory
cd core

# Install dependencies
npm install

# Start the development server
npm run dev

💻 Usage Examples

Basic Usage

import { OpenSumi } from '@opensumi/core';

// Initialize an OpenSumi instance
const os = new OpenSumi();

// Get core services
const coreServices = os.getCoreServices();

📚 Documentation

Project Structure

• src/: Source code directory containing all core modules and components.
• dist/: Build output directory for generating production - environment files.
• examples/: Example applications demonstrating how to use various features of OpenSumi.
• docs/: Documentation materials, including API documentation and usage guides.

👥 Contributors

  </picture>
</a>

  </picture>
</a>

  </picture>
</a>

🤝 Contribution Guidelines

We welcome every developer to contribute to OpenSumi. Please read our Contribution Guidelines to learn how to participate and submit code.

Submitting Code

1. Fork the repository: Fork the open - source project repository on GitHub.
2. Create a branch: Create a new branch for new features or bug fixes based on the main branch.
3. Commit your changes: Commit your changes to the new branch and follow the Commit Specification.
4. Submit a Pull Request: Click "Compare & pull request" on the repository page to submit your PR.

🐞 Issue Reporting

If you encounter any issues or have suggestions for improvement during use, please go to the Issues page to submit your problems.

📄 License

This project is licensed under the MIT License. For details, please see the LICENSE file.

Thank you for your support of OpenSumi! We look forward to your contributions to drive the development of the open - source community together!