Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/silvestreh/feathers-nuxt
A Feathers + Nuxt boilerplate for kick starting server-side rendered VueJS real-time applications.
https://github.com/silvestreh/feathers-nuxt
Last synced: 3 months ago
JSON representation
A Feathers + Nuxt boilerplate for kick starting server-side rendered VueJS real-time applications.
- Host: GitHub
- URL: https://github.com/silvestreh/feathers-nuxt
- Owner: silvestreh
- License: mit
- Created: 2017-04-30T15:12:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T03:09:09.000Z (over 1 year ago)
- Last Synced: 2024-07-06T00:07:51.579Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 5.72 MB
- Stars: 80
- Watchers: 7
- Forks: 20
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-feathersjs - feathers-nuxt - A sample/starter for server-side rendered Vue.js + Feathers applications that supports user authentication (Resources / Examples)
README
# feathers-nuxt
> A Feathers + Nuxt demo/boilerplate
[](https://heroku.com/deploy)
## About
This project uses [Feathers](http://feathersjs.com). An open source web framework for building modern real-time applications.
It also uses NeDB to store users. This is because NeDB handles data persistence in text files and it won't require you to have MongoDB, PostgreSQL, or any other database installed to just try this boilerplate.
Feathers and Vue/Nuxt integration is done through the amazing [`feathers-vuex`](https://github.com/feathers-plus/feathers-vuex).
Remember to set these environment variables when running in production:
```shell
NODE_ENV=production
PORT=3030 # or whatever port you want to use
API_URL=https://yourappdomain.com/ # this is where the API is running
AUTH_SECRET=[super-secret-hash] # make it long (>512 chars), and NEVER check it into source control
```
After that, you can safely start the application by using `npm start`, which will trigger a Nuxt build and then start the app.
Here's a [working demo](https://feathers-nuxt.herokuapp.com/) running on Heroku.
## ⚠️ Support
You may use this boilerplate for whatever projects you want, but beware that updates to it will be scarse. You're very much welcome to contribute if you find something is off.
> **Latest Update:** 2021-02-16
## 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
```
cd path/to/feathers-nuxt; npm install
```
3. Start your app
```
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:
```
$ npm install -g @feathersjs/cli # Install Feathers CLI
$ feathers generate service # Generate a new Service
$ feathers generate hook # Generate a new Hook
$ 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) and join us on [Slack](https://slack.feathersjs.com/).
For more information on `feathers-vuex`, visit [their docs](https://feathers-plus.github.io/v1/feathers-vuex/index.html).
For more information on `nuxt`, visit [their docs](https://nuxtjs.org/guide).
## Changelog
**0.0.0**
- Initial release
## License
Copyright (c) 2019 Silvestre Herrera.
Licensed under the [MIT license](LICENSE).