Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/femessage/create-nuxt-app

⚡️Create deepexi style nuxt app in seconds
https://github.com/femessage/create-nuxt-app

create-app element-ui nuxt vant

Last synced: 4 days ago
JSON representation

⚡️Create deepexi style nuxt app in seconds

Awesome Lists containing this project

README

        

# create-nuxt-app

[![Build Status](https://travis-ci.com/FEMessage/create-nuxt-app.svg?branch=master)](https://travis-ci.com/FEMessage/create-nuxt-app)
[![NPM Download](https://badgen.net/npm/dm/@femessage/create-nuxt-app)](https://www.npmjs.com/package/@femessage/create-nuxt-app)
[![NPM Version](https://badgen.net/npm/v/@femessage/create-nuxt-app)](https://www.npmjs.com/package/@femessage/create-nuxt-app)
[![NPM License](https://badgen.net/npm/license/@femessage/create-nuxt-app)](https://github.com/FEMessage/create-nuxt-app/blob/master/LICENSE)
[![PRs Welcome](https://badgen.net/badge/PRs/welcome/green)](https://github.com/FEMessage/create-nuxt-app/pulls)
[![semantic-release](https://badgen.net/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80/semantic-release/e10079)](https://github.com/semantic-release/semantic-release)

## Table of Contents

- [Introduction](#introduction)
- [Demo](#demo)
- [Features](#features)
- [Links](#links)
- [Usage](#usage)
- [Frameworks](#frameworks)
- [Developer Guide](#developer-guide)
- [Contributors](#contributors)
- [License](#license)

## Introduction

Create an enterprise nuxt app in seconds.

[⬆ Back to Top](#table-of-contents)

## Features

- [x] [typescript](https://www.typescriptlang.org/) TypeScript extends JavaScript by adding types.
- [x] [composition-api](https://composition-api.vuejs.org/) a set of additive, function-based APIs that allow flexible composition of component logic.
- [x] [prettier](https://prettier.io/) Prettier is an opinionated code formatter
- [x] [eslint](https://eslint.org/) A fully pluggable tool for identifying and reporting on patterns in JavaScript
- [x] [stylelint](https://stylelint.io/) A mighty, modern style linter
- [x] [commitlint](https://conventional-changelog.github.io/commitlint/) Lint commit messages
- [x] [gitlab-ci](https://about.gitlab.com/product/continuous-integration/) GitLab CI
- [x] [dotenv](https://github.com/motdotla/dotenv) Loads environment variables from .env for nodejs projects
- [x] [@femessage/element-ui](http://femessage.github.io/element/) A Vue.js 2.0 UI Toolkit for Web
- [x] [@femessage/vant](http://femessage.github.io/vant/) Lightweight Mobile UI Components built on Vue
- [x] [PWA](https://pwa.nuxtjs.org) Nuxt Progressive Web Apps solution
- [x] [API Manage](https://github.com/FEMessage/create-nuxt-app/blob/dev/docs/api.md) RESTful API management
- [x] [breadcrumb](https://www.yuque.com/docs/share/2fb86219-e8be-4007-a2b8-39641d5e79df)
- [x] [Cypress](https://www.cypress.io/)

[⬆ Back to Top](#table-of-contents)

## Inspiration

- [create-nuxt-app](https://github.com/nuxt/create-nuxt-app)
- [nuxt-element-dashboard](https://github.com/levy9527/nuxt-element-dashboard)

[⬆ Back to Top](#table-of-contents)

## [Demo](https://femessage.github.io/create-nuxt-app/)

### Nuxt-Admin

- tenantId admin
- account admin
- password abcd1234

**run local dev server**

```sh
# white a .env file in root
API_SERVER=https://mockapi.eolinker.com/IeZWjzy87c204a1f7030b2a17b00f3776ce0a07a5030a1b
APP_ID=1204701543597604893
```

## Links
- [TypeScript FAQ](https://deepexi.yuque.com/docs/share/ec81b0e7-b1b4-426c-a66c-8c293e7185c2)
- [Composition API Best Practices](https://deepexi.yuque.com/docs/share/54bd68ca-27bb-4db8-8b26-f2dd1de406ff)

## Usage

Make sure you have [npx](https://www.npmjs.com/package/npx) installed (`npx` is shipped by default since [npm](https://www.npmjs.com/get-npm) `5.2.0`)

One-off usage via npx:

```bash
npx @femessage/create-nuxt-app [my-project] -t [template]
```

Global install:

```bash
yarn global add @femessage/create-nuxt-app
```

Help text:

```bash
npx @femessage/create-nuxt-app -h

Usage:
create-nuxt-app [options]

Options:
-t, --template create a preset template
-l, --list the list of preset template
-a, --all generate all preset template
-o, --output the output path of the generator
-h, --help Display this message
-v, --version Display version number
```

Preview

![preview](https://i.loli.net/2020/02/17/B8FHNTerut53m14.gif)


[⬆ Back to Top](#table-of-contents)

## Frameworks

### Admin

```bash
npx @femessage/create-nuxt-app -t admin
```

![nuxt-admin](https://i.loli.net/2020/02/17/sMtU3kHCefAyRTN.jpg)

An PC admin template

Default account
admin
admin
abcd1234

### Mobile

```bash
npx @femessage/create-nuxt-app -t mobile
```

[⬆ Back to Top](#table-of-contents)

## Developer Guide

Please check out [developer guide](./developer-guide.md).

[⬆ Back to Top](#table-of-contents)

## Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

Han
Han

💻 📖 ⚠️ 🚇Donald Shen
Donald Shen

💻 ⚠️ 🚧levy
levy

👀 🚇OuZuYu
OuZuYu

💻EVILLT
EVILLT

💻 📖 🔧ColMugX
ColMugX

💻Shoyuf
Shoyuf

💻zhn4
zhn4

💻4Ark
4Ark

💻 🐛

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

[⬆ Back to Top](#table-of-contents)

## License

[MIT](./LICENSE)

[⬆ Back to Top](#table-of-contents)