mirror of https://github.com/nuxt/nuxt.git
51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
# Nuxt with [Feathers](http://feathersjs.com)
|
|
|
|
## About
|
|
|
|
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
|
|
|
|
## Getting Started
|
|
|
|
Getting up and running is as easy as 1, 2, 3.
|
|
|
|
1. Make sure you have [NodeJS](https://nodejs.org/) and [npm](https://www.npmjs.com/) installed.
|
|
2. Install your dependencies
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
3. Start your app
|
|
|
|
```bash
|
|
npm run dev
|
|
```
|
|
|
|
## Production
|
|
|
|
```bash
|
|
npm run build
|
|
npm start
|
|
```
|
|
|
|
## Testing
|
|
|
|
Simply run `npm test` and all your tests in the `test/` directory will be run.
|
|
|
|
## Scaffolding
|
|
|
|
Feathers has a powerful command line interface. Here are a few things it can do:
|
|
|
|
```bash
|
|
$ npm install -g feathers-cli # Install Feathers CLI
|
|
|
|
$ feathers generate service # Generate a new Service
|
|
$ feathers generate hook # Generate a new Hook
|
|
$ feathers generate model # Generate a new Model
|
|
$ feathers help # Show all commands
|
|
```
|
|
|
|
## Help
|
|
|
|
For more information on all the things you can do with Feathers visit [docs.feathersjs.com](http://docs.feathersjs.com).
|