# free-party-cli

> This is a scaffold to create a react application using vite react

Latest version **1.0.0** (published 2022-02-24) · 0 weekly downloads

## Install

```sh
npm install free-party-cli
pnpm add free-party-cli
yarn add free-party-cli
bun add free-party-cli
```

Provides the command `free-party-cli`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-02-24 |
| First published | 2022-02-24 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 119.7 KB |
| Known vulnerabilities | 0 (+8 in 1 direct dependencies) |
| Install scripts | no |
| Author | Andy-ask |
| Maintainers | andy-ask |
| Keywords | cli, typescript, react, vite |

## Links

- npm: https://www.npmjs.com/package/free-party-cli
- Repository: https://github.com/Andy-ask/free-party-template
- Homepage: https://github.com/Andy-ask/free-party-template#readme
- Issues: https://github.com/Andy-ask/free-party-template/issues
- npm.io page: https://npm.io/package/free-party-cli

## Dependencies (9)

- [ora](https://npm.io/package/ora.md) ^5.4.1
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.5.5
- [inquirer](https://npm.io/package/inquirer.md) ^8.1.1
- [commander](https://npm.io/package/commander.md) ^8.0.0
- [superagent](https://npm.io/package/superagent.md) ^6.1.0
- [typescript](https://npm.io/package/typescript.md) ^4.3.5
- [@types/node](https://npm.io/package/@types/node.md) ^16.3.1
- [@types/superagent](https://npm.io/package/@types/superagent.md) ^4.1.12
- [download-git-repo](https://npm.io/package/download-git-repo.md) ^3.0.2

## Recent versions

- 1.0.0 (latest) — 2022-02-24

## README

# Free Party Cli

Version 1.0.0

It will be improved later, currently it's the default version, pull the default configuration directly to configure, later it will be changed to configure on demand, currently it only supports front-end, later it will follow the back-end configuration

The default configuration is ``vite react redux redux-toolkit immer react-router axios mockjs sass``

## How to create a project
You just need to `npm install -g free-party-cli` to install it globally, and then use `free-party-cli create ProjectName` to create your project

## How to use the installed free-party-cli
```node
Download packages
pnpm install | yarn install | npm install

The recommended way to start, using the pnpm package management tool
pnpm dev | yarn dev | npm run dev

Build method
pnpm build | yarn build | npm run build
```

## Project Catalog
```javascript
Project directory
|-- README-zh.md
|-- README.md
|-- envs------------------environment variables
|-- favicon.svg
|-- index.html------------html entry
|-- mock------------------mock requests
|   |-- index.ts        
|-- package.json
|-- src
|   |-- App.tsx-----------react main component
|   |-- common
|   |   |-- fonts---------font file
|   |   |-- images--------image files
|   |   |-- style---------public style files
|   |   |-- ts------------public ts methods
|   |-- components--------components
|   |   |-- counter-------example calculation component
|   |   |-- sidebar
|   |-- main.tsx----------entry file
|   |-- pages-------------routing pages
|   |   |-- about
|   |   |-- home
|   |-- router------------react-router
|   |   |-- index.tsx
|   |   |-- router-view---wrapped router-view
|   |-- store-------------redux
|   |-- vite-env.d.ts-----types of vite environment variables
|-- tsconfig.json---------ts Configuration
|-- tsconfig.node.json
|-- types-----------------types
|-- vite.config.ts--------vite configuration file
```

---
_Source: https://npm.io/package/free-party-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._