xmars-open-source/XMarsUI

A complete tool for you to make a perfect UI

XMars UI

Sleek, intuitive, and powerful front-end framework for faster and easier web development.
Explore XMars UI docs »

Website · Report bug · Request feature

Table of contents

• Quick start
• Bugs and feature requests
• Documentation
• Contributing
• Copyright and license

Quick start

Several quick start options are available:

• Clone the repo: git clone https://github.com/xmars-open-source/XMarsUI.git
• Install with npm: npm install xmars-ui

Read the Getting started page for information on the framework contents, and examples, and more.

Bugs and feature requests

Have a bug or a feature request? Please open a new issue.

Documentation

XMars UI's documentation, included in this repo in the root directory, is built with Docusaurus and publicly hosted on GitHub Pages at https://ui.xmars.io. The docs may also be run locally.

Running documentation locally

1. Go to the root /docs directory
2. Run npm install to install the Node.js dependencies, including Docusaurus (the site builder).
3. Go to the same directory, run npm start in the command line.
4. Open http://localhost:3000/ in your browser, and voilà.

Learn more about using Docusaurus by reading its documentation.

Contributing

We are glad to see any type of contributing

Copyright and license

MIT License