# origin.js

**Repository Path**: originjs/origin.js

## Basic Information

- **Project Name**: origin.js
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 1
- **Created**: 2021-09-03
- **Last Updated**: 2025-01-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Origin.js

<p align="center"><img align="center" style="width:240px" src="./.github/originjs.png"/></p><br/>
<p align="center">
  <a href="https://github.com/originjs/origin.js/actions/workflows/ci.yml"><img src="https://github.com/originjs/origin.js/actions/workflows/ci.yml/badge.svg?branch=main" alt="Build Status"></a>
  <a href="https://www.npmjs.com/package/@originjs/cli"><img src="https://badgen.net/npm/v/@originjs/cli" alt="Version"></a>
  <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/vite.svg" alt="Node Compatibility"></a>
  <a href="https://www.npmjs.com/package/@originjs/cli"><img src="https://badgen.net/npm/license/origin.js" alt="License"></a>
 </p>

> A simple and powerful Vue.js web application framework that provides a complete set of web project solutions based on Vue.js.

## Core project status

| Projects                                                     | CI status                                                    | Vulnerability                                                | Code scanning                                                |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| [core](https://github.com/wangsongc/core.git)                | [![CI](https://github.com/wangsongc/core-test/actions/workflows/action2.yml/badge.svg)](https://github.com/wangsongc/core-test/actions/workflows/action2.yml) | [![Known Vulnerabilities](https://snyk.io/test/github/wangsongc/core/badge.svg)](https://snyk.io/test/github/wangsongc/core) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=wangsongc_core&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=wangsongc_core) |
| [vue-i18n-next](https://github.com/wangsongc/vue-i18n-next.git) | [![CI](https://github.com/wangsongc/core-test/actions/workflows/action2.yml/badge.svg)](https://github.com/wangsongc/core-test/actions/workflows/action2.yml) | [![Known Vulnerabilities](https://snyk.io/test/github/wangsongc/vue-i18n-next/badge.svg)](https://snyk.io/test/github/wangsongc/vue-i18n-next) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=wangsongc_vue-i18n-next&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=wangsongc_vue-i18n-next) |
| [router](https://github.com/wangsongc/router.git)            | [![CI](https://github.com/wangsongc/core-test/actions/workflows/action2.yml/badge.svg)](https://github.com/wangsongc/core-test/actions/workflows/action2.yml) | [![Known Vulnerabilities](https://snyk.io/test/github/wangsongc/router/badge.svg)](https://snyk.io/test/github/wangsongc/router) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=wangsongc_pinia&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=wangsongc_pinia) |
| [pinia](https://github.com/wangsongc/pinia.git)              | [![CI](https://github.com/wangsongc/core-test/actions/workflows/action2.yml/badge.svg)](https://github.com/wangsongc/core-test/actions/workflows/action2.yml) | [![Known Vulnerabilities](https://snyk.io/test/github/wangsongc/pinia/badge.svg)](https://snyk.io/test/github/wangsongc/pinia) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=wangsongc_router&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=wangsongc_router) |


## Features
- Based on [Vue 3](https://vuejs.org) & [Vite2](https://v2.vitejs.dev/)
- [Vue i18n](https://kazupon.github.io/vue-i18n/) intergrated
- [Pinia](https://pinia.vuejs.org/) or [Vuex](https://vuex.vuejs.org/) for Vue store
- [Jest](https://jestjs.io/) or [Vitest](https://vitest.dev/) for Vue component testing
- Global styles with css, sass, less or stylus
- Auto-imported Vue components
- File based routing and layouts
- Open `yaml/xml/xlsx/...` as a ES module
- Markdown support
- Host or remote project for module federation
- [Webpack to vite conversion tool](https://github.com/originjs/webpack-to-vite)
- [A migration tool from Vue 2 to Vue 3](https://github.com/originjs/vue-codemod)

View [Documentation](https://originjs.org/en/) for more information.

## Plugins
- GlobalStyle - [`@originjs/vite-plugin-global-style`](https://github.com/originjs/origin.js/tree/main/packages/vite-plugin-global-style)
- Layouts & Pages - [`@originjs/vite-plugin-pages`](https://github.com/originjs/origin.js/tree/main/packages/vite-plugin-pages)
- Components - [`vite-plugin-components`](https://github.com/antfu/vite-plugin-components)
- Markdown - [`vite-plugin-md`](https://github.com/antfu/vite-plugin-md)
- Content - [`@originjs/vite-plugin-content`](https://github.com/originjs/origin.js/tree/main/packages/vite-plugin-content)
- Module Federation - [`@originjs/vite-plugin-federation`](https://github.com/originjs/vite-plugin-federation)

## Installation
```shell
npm install -g @originjs/cli
```
or
```shell
yarn global add @originjs/cli
```

## Getting started
To create a new application with origin.js, just run:
```shell
ori init <app-name>
```

## Examples
- [Vue 3 project using origin.js plugins](https://github.com/originjs/origin.js/tree/main/examples/vue3)
- [Origin.js templates](https://github.com/konpeki622/origin-demo)

## To be contributor

Read [contributing guide](https://github.com/originjs/origin.js/blob/main/CONTRIBUTING_GUIDE.md).