nuxtathon icon indicating copy to clipboard operation
nuxtathon copied to clipboard

A boiler-plate for nuxt to start building your application

Nuxtathon

Nuxt.js with all the goodies hooked up, ready for you to start building.

screenshot

WIP

Goal of this project is to give you the best Nuxt boilerplate to get started working on your app. Gaining inspiration from (hackathon starter)[https://github.com/sahat/hackathon-starter], nuxtathon will additional boilerplate code for

  • routing through express
  • in-memory mongodb or containerized mongodb
  • basic user Model using mongoose
  • authentication through passport
  • Dashboards for registered User and Admin
  • Awesome nuxt modules (Buefy, PWA, Axios)

Goal of this project is to make it easy to develop in nuxt by providing an express interface using serverMiddleware. Gaining inspiration from but wanting to add more by providing a basic admin interface as well.

I have Just started working on this but currently allows you to login with github using a passport extension. Other things to come are

  • [x] hot reloading of express routes as a serverMiddleware in Nuxt
  • [x] passport integration (github auth)
  • [x] Buefy
  • [ ] PWA
  • [ ] Axios Integration
  • [ ] User model
  • [ ] Registration & Login
  • [ ] User Dashboard
  • [ ] Admin Dashboard
  • [ ] Containerized in Docker (mongoo
  • [ ] In-memory mongodb

Build Setup

# install dependencies
$ npm install # Or yarn install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm start

# generate static project
$ npm run generate

Build Setup with Docker

Nuxt, Mongo and Proxy container will start

# start containers
docker-compose up

For detailed explanation on how things work, checkout the Nuxt.js docs.