Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/Tarrask/sails-template

Starter template for Nuxt.js with SailsJS. https://nuxtjs.org
https://github.com/Tarrask/sails-template

Last synced: 13 days ago
JSON representation

Starter template for Nuxt.js with SailsJS. https://nuxtjs.org

Awesome Lists containing this project

README

        

# Nuxt.js with Sails

> [SailsJS](https://sailsjs.com) + [Nuxt.js](https://nuxtjs.org) = :zap:

## Installation

This is a project template for [vue-cli](https://github.com/vuejs/vue-cli).

```bash
vue init tarrask/sails-template
cd # move to your project
npm install # or yarn install*[see note below]
```

> Make sure to use a version of vue-cli >= 2.1 (vue -V).

If you are using vue-cli >= 3.0, you have to install a [global bridge](https://cli.vuejs.org/guide/creating-a-project.html#pulling-2-x-templates-legacy):
```bash
npm install -g @vue/cli-init
```

*Note: Due to a bug in yarn's engine version detection code if you are
using a prerelease version of Node (i.e. v7.6.0-rc.1) you will need to either:

1. Use `npm install`
2. Run `yarn` with a standard release of Node and then switch back

## Commands

| Command | Description |
|---------|-------------|
| npm run dev | Lift sails server in development with Nuxt.js in dev mode (hot reloading). Listen on [http://localhost:1337](http://localhost:3000). |
| npm run build | Build the nuxt.js web application for production. |
| npm start | Start sails server in production. |

## Configuration
The `nuxt.config.js` is located in the `config/nuxt.js` to follow sails convention and to use it from a sails hook.

To access the sails backend from nuxt, you can use the [axios](https://axios.nuxtjs.org/). It is preconfigured by the hook to point to the sails port. For it to work from the client, you may need to add `proxy: true` to nuxt.js

```
module.exports.nuxt = {
modules: [ '@nuxtjs/axios' ],
axios: {
proxy: true
}
}
```

## Documentation

- [Sails.js](https://sailsjs.com)
- [Nuxt.js](https://nuxtjs.org/guide/)
- [Vue.js](http://vuejs.org/guide/)

### Links

+ [Get started](https://sailsjs.com/get-started)
+ [Sails framework documentation](https://sailsjs.com/documentation)
+ [Version notes / upgrading](https://sailsjs.com/documentation/upgrading)
+ [Deployment tips](https://sailsjs.com/documentation/concepts/deployment)
+ [Community support options](https://sailsjs.com/support)
+ [Professional / enterprise options](https://sailsjs.com/enterprise)

## Licenses

- [SailsJS license](https://github.com/balderdashy/sails/blob/master/LICENSE.md)
- [NuxtJS license](https://github.com/nuxt/nuxt.js/blob/master/LICENSE.md)
- [VueJS license](https://github.com/vuejs/vue/blob/master/LICENSE)