├── client
├── static
│ ├── .gitkeep
│ └── favicon.png
├── .eslintignore
├── config
│ ├── prod.env.js
│ ├── dev.env.js
│ └── index.js
├── .editorconfig
├── .babelrc
├── .postcssrc.js
├── src
│ ├── constants
│ │ └── graphql.js
│ ├── store
│ │ └── index.js
│ ├── router
│ │ └── index.js
│ ├── main.js
│ ├── App.vue
│ ├── components
│ │ └── welcomeComponent.vue
│ └── apollo
│ │ └── index.js
├── build
│ ├── vue-loader.conf.js
│ ├── build.js
│ ├── check-versions.js
│ ├── webpack.base.conf.js
│ ├── utils.js
│ ├── webpack.dev.conf.js
│ └── webpack.prod.conf.js
├── index.html
├── .eslintrc.js
└── package.json
├── server
├── .babelrc
├── src
│ ├── models
│ │ └── index.js
│ ├── graphql
│ │ ├── types
│ │ │ └── types.js
│ │ └── resolvers
│ │ │ └── resolvers.js
│ └── server.js
└── package.json
└── README.md
/client/static/.gitkeep:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/client/.eslintignore:
--------------------------------------------------------------------------------
1 | /build/
2 | /config/
3 | /dist/
4 | /*.js
5 |
--------------------------------------------------------------------------------
/client/config/prod.env.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | module.exports = {
3 | NODE_ENV: '"production"'
4 | }
5 |
--------------------------------------------------------------------------------
/client/static/favicon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/romucci/boilerplate-vue-apollo-graphql-mongodb/HEAD/client/static/favicon.png
--------------------------------------------------------------------------------
/client/config/dev.env.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const merge = require('webpack-merge')
3 | const prodEnv = require('./prod.env')
4 |
5 | module.exports = merge(prodEnv, {
6 | NODE_ENV: '"development"'
7 | })
8 |
--------------------------------------------------------------------------------
/server/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | "env"
4 | ],
5 | "plugins": [
6 | ["transform-runtime", {
7 | "polyfill": false,
8 | "regenerator": true
9 | }]
10 | ]
11 | }
--------------------------------------------------------------------------------
/client/.editorconfig:
--------------------------------------------------------------------------------
1 | root = true
2 |
3 | [*]
4 | charset = utf-8
5 | indent_style = space
6 | indent_size = 2
7 | end_of_line = lf
8 | insert_final_newline = true
9 | trim_trailing_whitespace = true
10 |
--------------------------------------------------------------------------------
/server/src/models/index.js:
--------------------------------------------------------------------------------
1 | import mongoose from 'mongoose'
2 |
3 | const messageSchema = mongoose.Schema({
4 | message: String
5 | })
6 |
7 | const Message = mongoose.model('messages', messageSchema)
8 |
9 | export default Message
--------------------------------------------------------------------------------
/client/.babelrc:
--------------------------------------------------------------------------------
1 | {
2 | "presets": [
3 | ["env", {
4 | "modules": false,
5 | "targets": {
6 | "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
7 | }
8 | }],
9 | "stage-2"
10 | ],
11 | "plugins": ["transform-vue-jsx", "transform-runtime"]
12 | }
13 |
--------------------------------------------------------------------------------
/client/.postcssrc.js:
--------------------------------------------------------------------------------
1 | // https://github.com/michael-ciniawsky/postcss-load-config
2 |
3 | module.exports = {
4 | "plugins": {
5 | "postcss-import": {},
6 | "postcss-url": {},
7 | // to edit target browsers: use "browserslist" field in package.json
8 | "autoprefixer": {}
9 | }
10 | }
11 |
--------------------------------------------------------------------------------
/client/src/constants/graphql.js:
--------------------------------------------------------------------------------
1 | import gql from 'graphql-tag'
2 |
3 | // GREETING QUERY
4 | export const GREETING_QUERY = gql`
5 | query greeting {
6 | getGreeting
7 | }
8 | `
9 |
10 | // GREETING SEEN SUBSCRIPTION
11 | export const GREETING_SUBSCRIPTION = gql`
12 | subscription greetingSeen {
13 | greetingSeen
14 | }
15 | `
16 |
--------------------------------------------------------------------------------
/client/src/store/index.js:
--------------------------------------------------------------------------------
1 | import Vue from 'vue'
2 | import Vuex from 'vuex'
3 | import apolloClient from '../apollo/index'
4 |
5 | Vue.use(Vuex)
6 |
7 | const store = new Vuex.Store({
8 | state: {
9 | storeMessage: 'Hello from the Vuex Store!',
10 | alert: false
11 | },
12 | actions: {
13 | apolloShow () {
14 | console.log(apolloClient)
15 | }
16 | }
17 | })
18 |
19 | export default store
20 |
--------------------------------------------------------------------------------
/server/src/graphql/types/types.js:
--------------------------------------------------------------------------------
1 | export default `
2 |
3 | type Human {
4 | name: String!
5 | age: Int
6 | country: String
7 | }
8 |
9 | type Query {
10 | getGreeting: String!
11 | }
12 |
13 | type Subscription {
14 | greetingSeen: String!
15 | }
16 |
17 | schema {
18 | query: Query
19 | subscription : Subscription
20 | }
21 |
22 | `
--------------------------------------------------------------------------------
/client/src/router/index.js:
--------------------------------------------------------------------------------
1 | // IMPORTS
2 | import Vue from 'vue'
3 | import Router from 'vue-router'
4 | import welcomeComponent from '../components/welcomeComponent'
5 |
6 | Vue.use(Router)
7 |
8 | // ROUTES
9 | const routes = [
10 | {
11 | path: '/',
12 | name: 'welcome',
13 | component: welcomeComponent
14 | }
15 | ]
16 | // EXPORT ROUTER
17 | export default new Router({
18 | mode: 'history',
19 | routes
20 | })
21 |
--------------------------------------------------------------------------------
/server/src/graphql/resolvers/resolvers.js:
--------------------------------------------------------------------------------
1 | import { PubSub } from 'graphql-subscriptions'
2 |
3 | export const pubsub = new PubSub()
4 |
5 | export default {
6 | Subscription: {
7 | greetingSeen: {
8 | subscribe: () => pubsub.asyncIterator('GREETING_SEEN')
9 | }
10 | },
11 | Query: {
12 | getGreeting: (parent, args, models) => {
13 | const greeting = 'Hello from the server!'
14 | pubsub.publish('GREETING_SEEN', { greetingSeen: greeting })
15 | return 'Hello from the server!'
16 | }
17 | }
18 |
19 | }
--------------------------------------------------------------------------------
/client/build/vue-loader.conf.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const utils = require('./utils')
3 | const config = require('../config')
4 | const isProduction = process.env.NODE_ENV === 'production'
5 | const sourceMapEnabled = isProduction
6 | ? config.build.productionSourceMap
7 | : config.dev.cssSourceMap
8 |
9 | module.exports = {
10 | loaders: utils.cssLoaders({
11 | sourceMap: sourceMapEnabled,
12 | extract: isProduction
13 | }),
14 | cssSourceMap: sourceMapEnabled,
15 | cacheBusting: config.dev.cacheBusting,
16 | transformToRequire: {
17 | video: ['src', 'poster'],
18 | source: 'src',
19 | img: 'src',
20 | image: 'xlink:href'
21 | }
22 | }
23 |
--------------------------------------------------------------------------------
/client/src/main.js:
--------------------------------------------------------------------------------
1 | // IMPORTS
2 | import Vue from 'vue'
3 | import VueApollo from 'vue-apollo'
4 | import Vuetify from 'vuetify'
5 | import ApolloClient from './apollo'
6 | import store from './store'
7 | import router from './router'
8 | import App from './App'
9 |
10 | // SETUP PLUGINS
11 | Vue.config.productionTip = false
12 | Vue.use(VueApollo)
13 | Vue.use(Vuetify)
14 |
15 | // APOLLO PROVIDER
16 | const apolloProvider = new VueApollo({
17 | defaultClient: ApolloClient,
18 | defaultOptions: {
19 | $loadingKey: 'loading'
20 | }
21 | })
22 |
23 | new Vue({
24 | store,
25 | router,
26 | el: '#app',
27 | provide: apolloProvider.provide(),
28 | render: h => h(App)
29 | })
30 |
--------------------------------------------------------------------------------
/client/src/App.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 | Someone saw the message!
9 |
10 |
11 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
25 |
26 |
38 |
--------------------------------------------------------------------------------
/client/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 | Boilerplate Vue - Vuex - Apollo - GraphQL - MongoDB
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
--------------------------------------------------------------------------------
/client/.eslintrc.js:
--------------------------------------------------------------------------------
1 | // https://eslint.org/docs/user-guide/configuring
2 |
3 | module.exports = {
4 | root: true,
5 | parserOptions: {
6 | parser: 'babel-eslint'
7 | },
8 | env: {
9 | browser: true,
10 | },
11 | extends: [
12 | // https://github.com/vuejs/eslint-plugin-vue#priority-a-essential-error-prevention
13 | // consider switching to `plugin:vue/strongly-recommended` or `plugin:vue/recommended` for stricter rules.
14 | 'plugin:vue/essential',
15 | // https://github.com/standard/standard/blob/master/docs/RULES-en.md
16 | 'standard'
17 | ],
18 | // required to lint *.vue files
19 | plugins: [
20 | 'vue'
21 | ],
22 | // add your custom rules here
23 | rules: {
24 | // allow new
25 | 'no-new': 'off',
26 | // allow async-await
27 | 'generator-star-spacing': 'off',
28 | // allow debugger during development
29 | 'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off'
30 | }
31 | }
32 |
--------------------------------------------------------------------------------
/server/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "boilerplate-vue-apollo-graphql-express-mongodb-server-side",
3 | "version": "1.0.0",
4 | "description": "",
5 | "author": "Lucas Otero",
6 | "scripts": {
7 | "start": "babel-watch src/server.js"
8 | },
9 | "license": "MIT",
10 | "dependencies": {
11 | "apollo-server-express": "^1.3.4",
12 | "babel-runtime": "^6.26.0",
13 | "cors": "^2.8.4",
14 | "dotenv": "^5.0.1",
15 | "express": "^4.16.3",
16 | "graphql": "^0.13.2",
17 | "graphql-subscriptions": "^0.5.8",
18 | "graphql-tools": "^2.24.0",
19 | "merge-graphql-schemas": "^1.5.1",
20 | "mongoose": "^5.0.14",
21 | "morgan": "^1.9.0",
22 | "serve-favicon": "^2.5.0",
23 | "serve-static": "^1.13.2",
24 | "spdy": "^3.4.7",
25 | "subscriptions-transport-ws": "^0.9.9"
26 | },
27 | "devDependencies": {
28 | "babel-cli": "^6.26.0",
29 | "babel-core": "^6.26.0",
30 | "babel-loader": "^7.1.4",
31 | "babel-plugin-transform-runtime": "^6.23.0",
32 | "babel-polyfill": "^6.26.0",
33 | "babel-preset-env": "^1.6.1",
34 | "babel-watch": "^2.0.7"
35 | }
36 | }
37 |
--------------------------------------------------------------------------------
/client/build/build.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | require('./check-versions')()
3 |
4 | process.env.NODE_ENV = 'production'
5 |
6 | const ora = require('ora')
7 | const rm = require('rimraf')
8 | const path = require('path')
9 | const chalk = require('chalk')
10 | const webpack = require('webpack')
11 | const config = require('../config')
12 | const webpackConfig = require('./webpack.prod.conf')
13 |
14 | const spinner = ora('building for production...')
15 | spinner.start()
16 |
17 | rm(path.join(config.build.assetsRoot, config.build.assetsSubDirectory), err => {
18 | if (err) throw err
19 | webpack(webpackConfig, (err, stats) => {
20 | spinner.stop()
21 | if (err) throw err
22 | process.stdout.write(stats.toString({
23 | colors: true,
24 | modules: false,
25 | children: false, // If you are using ts-loader, setting this to true will make TypeScript errors show up during build.
26 | chunks: false,
27 | chunkModules: false
28 | }) + '\n\n')
29 |
30 | if (stats.hasErrors()) {
31 | console.log(chalk.red(' Build failed with errors.\n'))
32 | process.exit(1)
33 | }
34 |
35 | console.log(chalk.cyan(' Build complete.\n'))
36 | console.log(chalk.yellow(
37 | ' Tip: built files are meant to be served over an HTTP server.\n' +
38 | ' Opening index.html over file:// won\'t work.\n'
39 | ))
40 | })
41 | })
42 |
--------------------------------------------------------------------------------
/client/build/check-versions.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const chalk = require('chalk')
3 | const semver = require('semver')
4 | const packageConfig = require('../package.json')
5 | const shell = require('shelljs')
6 |
7 | function exec (cmd) {
8 | return require('child_process').execSync(cmd).toString().trim()
9 | }
10 |
11 | const versionRequirements = [
12 | {
13 | name: 'node',
14 | currentVersion: semver.clean(process.version),
15 | versionRequirement: packageConfig.engines.node
16 | }
17 | ]
18 |
19 | if (shell.which('npm')) {
20 | versionRequirements.push({
21 | name: 'npm',
22 | currentVersion: exec('npm --version'),
23 | versionRequirement: packageConfig.engines.npm
24 | })
25 | }
26 |
27 | module.exports = function () {
28 | const warnings = []
29 |
30 | for (let i = 0; i < versionRequirements.length; i++) {
31 | const mod = versionRequirements[i]
32 |
33 | if (!semver.satisfies(mod.currentVersion, mod.versionRequirement)) {
34 | warnings.push(mod.name + ': ' +
35 | chalk.red(mod.currentVersion) + ' should be ' +
36 | chalk.green(mod.versionRequirement)
37 | )
38 | }
39 | }
40 |
41 | if (warnings.length) {
42 | console.log('')
43 | console.log(chalk.yellow('To use this template, you must update following to modules:'))
44 | console.log()
45 |
46 | for (let i = 0; i < warnings.length; i++) {
47 | const warning = warnings[i]
48 | console.log(' ' + warning)
49 | }
50 |
51 | console.log()
52 | process.exit(1)
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/client/src/components/welcomeComponent.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
10 | Vuex Store
11 |
12 |
18 | {{ vuexMessage }}
19 |
20 |
27 | GraphQL Server
28 |
29 |
35 | {{ serverMessage }}
36 |
37 |
38 |
39 |
40 |
89 |
90 |
99 |
--------------------------------------------------------------------------------
/client/config/index.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | // Template version: 1.3.1
3 | // see http://vuejs-templates.github.io/webpack for documentation.
4 |
5 | const path = require('path')
6 |
7 | module.exports = {
8 | dev: {
9 |
10 | // Paths
11 | assetsSubDirectory: 'static',
12 | assetsPublicPath: '/',
13 | proxyTable: {},
14 |
15 | // Various Dev Server settings
16 | host: 'localhost', // can be overwritten by process.env.HOST
17 | port: 8080, // can be overwritten by process.env.PORT, if port is in use, a free one will be determined
18 | autoOpenBrowser: false,
19 | errorOverlay: true,
20 | notifyOnErrors: true,
21 | poll: false, // https://webpack.js.org/configuration/dev-server/#devserver-watchoptions-
22 |
23 | // Use Eslint Loader?
24 | // If true, your code will be linted during bundling and
25 | // linting errors and warnings will be shown in the console.
26 | useEslint: true,
27 | // If true, eslint errors and warnings will also be shown in the error overlay
28 | // in the browser.
29 | showEslintErrorsInOverlay: false,
30 |
31 | /**
32 | * Source Maps
33 | */
34 |
35 | // https://webpack.js.org/configuration/devtool/#development
36 | devtool: 'cheap-module-eval-source-map',
37 |
38 | // If you have problems debugging vue-files in devtools,
39 | // set this to false - it *may* help
40 | // https://vue-loader.vuejs.org/en/options.html#cachebusting
41 | cacheBusting: true,
42 |
43 | cssSourceMap: true
44 | },
45 |
46 | build: {
47 | // Template for index.html
48 | index: path.resolve(__dirname, '../dist/index.html'),
49 |
50 | // Paths
51 | assetsRoot: path.resolve(__dirname, '../dist'),
52 | assetsSubDirectory: 'static',
53 | assetsPublicPath: '/',
54 |
55 | /**
56 | * Source Maps
57 | */
58 |
59 | productionSourceMap: true,
60 | // https://webpack.js.org/configuration/devtool/#production
61 | devtool: '#source-map',
62 |
63 | // Gzip off by default as many popular static hosts such as
64 | // Surge or Netlify already gzip all static assets for you.
65 | // Before setting to `true`, make sure to:
66 | // npm install --save-dev compression-webpack-plugin
67 | productionGzip: false,
68 | productionGzipExtensions: ['js', 'css'],
69 |
70 | // Run the build command with an extra argument to
71 | // View the bundle analyzer report after build finishes:
72 | // `npm run build --report`
73 | // Set to `true` or `false` to always turn it on or off
74 | bundleAnalyzerReport: process.env.npm_config_report
75 | }
76 | }
77 |
--------------------------------------------------------------------------------
/client/src/apollo/index.js:
--------------------------------------------------------------------------------
1 | import { ApolloClient } from 'apollo-client'
2 | import { ApolloLink, split } from 'apollo-link'
3 | import { onError } from 'apollo-link-error'
4 | import { setContext } from 'apollo-link-context'
5 | import { WebSocketLink } from 'apollo-link-ws'
6 | import { createHttpLink } from 'apollo-link-http'
7 | import { InMemoryCache } from 'apollo-cache-inmemory'
8 |
9 | import { getMainDefinition } from 'apollo-utilities'
10 |
11 | // SET HTTP or HTTPS LINK * JUST ADD TO HTTP *
12 | const httpLink = createHttpLink({
13 | uri: 'http://localhost:8081/graphql'
14 | })
15 |
16 | // SET CONTEXT WITH HEADERS * WORKS FOR AUTHENTICATION *
17 | const middlewareLink = setContext(() => ({
18 | headers: {
19 | 'x-token': localStorage.getItem('token'),
20 | 'x-refresh-token': localStorage.getItem('refreshToken')
21 | }
22 | }))
23 |
24 | // SET TOKENS AFTER THE RESPONSE
25 | const afterwareLink = new ApolloLink((operation, forward) => {
26 | return forward(operation).map(response => {
27 | const { response: { headers } } = operation.getContext()
28 | if (headers) {
29 | const token = headers.get('x-token')
30 | // const refreshToken = headers.get('x-refresh-token')
31 |
32 | if (token) {
33 | localStorage.setItem('token', token)
34 | }
35 | /* UNCOMMENT FOR REFRESH TOKENS
36 | if (refreshToken) {
37 | localStorage.setItem('refreshToken', refreshToken)
38 | }
39 | */
40 | }
41 |
42 | return response
43 | })
44 | })
45 |
46 | // JOINING THE APOLLO LINKS
47 | const httpLinkWithMiddleware = afterwareLink.concat(
48 | middlewareLink.concat(httpLink)
49 | )
50 |
51 | // CREATE WEBSOCKET LINK * ADD S TO WS FOR HTTP2 *
52 | const wsLink = new WebSocketLink({
53 | uri: 'ws://localhost:8081/subscriptions',
54 | options: {
55 | reconnect: true,
56 | connectionParams: {
57 | token: localStorage.getItem('token')
58 | // refreshToken: localStorage.getItem('refreshToken')
59 | }
60 | }
61 | })
62 |
63 | // ERROR HANDLING
64 | const error = onError(({ graphQLErrors, networkError }) => {
65 | if (graphQLErrors) {
66 | console.log(`[GraphQL error]: ${networkError}`)
67 | } else if (networkError) {
68 | console.log(`[Network error]: ${networkError}`)
69 | }
70 | })
71 |
72 | // SPLIT QUERIES AND SUBSCRIPTIONS
73 | const link = split(
74 | ({ query }) => {
75 | const { kind, operation } = getMainDefinition(query)
76 | return kind === 'OperationDefinition' && operation === 'subscription'
77 | },
78 | wsLink,
79 | httpLinkWithMiddleware
80 | )
81 |
82 | // EXPORT APOLLO CLIENT
83 | export default new ApolloClient({
84 | link: error.concat(link),
85 | cache: new InMemoryCache(),
86 | connectToDevTools: true
87 | })
88 |
--------------------------------------------------------------------------------
/client/build/webpack.base.conf.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const utils = require('./utils')
4 | const config = require('../config')
5 | const vueLoaderConfig = require('./vue-loader.conf')
6 |
7 | function resolve (dir) {
8 | return path.join(__dirname, '..', dir)
9 | }
10 |
11 | const createLintingRule = () => ({
12 | test: /\.(js|vue)$/,
13 | loader: 'eslint-loader',
14 | enforce: 'pre',
15 | include: [resolve('src'), resolve('test')],
16 | options: {
17 | formatter: require('eslint-friendly-formatter'),
18 | emitWarning: !config.dev.showEslintErrorsInOverlay
19 | }
20 | })
21 |
22 | module.exports = {
23 | context: path.resolve(__dirname, '../'),
24 | entry: {
25 | app: './src/main.js'
26 | },
27 | output: {
28 | path: config.build.assetsRoot,
29 | filename: '[name].js',
30 | publicPath: process.env.NODE_ENV === 'production'
31 | ? config.build.assetsPublicPath
32 | : config.dev.assetsPublicPath
33 | },
34 | resolve: {
35 | extensions: ['.js', '.vue', '.json'],
36 | alias: {
37 | 'vue$': 'vue/dist/vue.esm.js',
38 | '@': resolve('src'),
39 | }
40 | },
41 | module: {
42 | rules: [
43 | ...(config.dev.useEslint ? [createLintingRule()] : []),
44 | {
45 | test: /\.vue$/,
46 | loader: 'vue-loader',
47 | options: vueLoaderConfig
48 | },
49 | {
50 | test: /\.js$/,
51 | loader: 'babel-loader',
52 | include: [resolve('src'), resolve('test'), resolve('node_modules/webpack-dev-server/client')]
53 | },
54 | {
55 | test: /\.(png|jpe?g|gif|svg)(\?.*)?$/,
56 | loader: 'url-loader',
57 | options: {
58 | limit: 10000,
59 | name: utils.assetsPath('img/[name].[hash:7].[ext]')
60 | }
61 | },
62 | {
63 | test: /\.(mp4|webm|ogg|mp3|wav|flac|aac)(\?.*)?$/,
64 | loader: 'url-loader',
65 | options: {
66 | limit: 10000,
67 | name: utils.assetsPath('media/[name].[hash:7].[ext]')
68 | }
69 | },
70 | {
71 | test: /\.(woff2?|eot|ttf|otf)(\?.*)?$/,
72 | loader: 'url-loader',
73 | options: {
74 | limit: 10000,
75 | name: utils.assetsPath('fonts/[name].[hash:7].[ext]')
76 | }
77 | }
78 | ]
79 | },
80 | node: {
81 | // prevent webpack from injecting useless setImmediate polyfill because Vue
82 | // source contains it (although only uses it if it's native).
83 | setImmediate: false,
84 | // prevent webpack from injecting mocks to Node native modules
85 | // that does not make sense for the client
86 | dgram: 'empty',
87 | fs: 'empty',
88 | net: 'empty',
89 | tls: 'empty',
90 | child_process: 'empty'
91 | }
92 | }
93 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Boilerplate Vue + Vuex + Vuetify + Apollo Client + GraphQL + Express + MongoDB + HTTP/2
2 |
3 | Just a simple way of starting your projects with these marvelous technologies!
4 |
5 | ### Installing
6 | Download or clone the repository and access the server folder.
7 |
8 | ```
9 | - cd server
10 | - npm install
11 | ```
12 |
13 | Then navigate towards the client folder and wait for dependencies to finish downloading.
14 |
15 | ```
16 | - cd client
17 | - npm install
18 | ```
19 |
20 | After that you will need to determine your the MongoDB connection string in server.js,
21 | as well as the database user and password inside an .env file in the server folder.
22 | Furthermore you can setup HTTP/2 with a CERT and KEY files (Use OpenSSL if you do not own a valid certificate).
23 |
24 | When everything is ready, you just navigate and start the server and client:
25 |
26 | ```
27 | - cd client
28 | - npm start
29 | ```
30 |
31 | and
32 |
33 | ```
34 | - cd server
35 | - npm start
36 | ```
37 |
38 | and VOALA, you are good to go!
39 |
40 | ## Build
41 |
42 | If you need or want to build your client app and use just one server, you can perform
43 |
44 | ```
45 | - cd client
46 | - npm run build
47 | ```
48 |
49 | then you take the output folder and take it to the server-side src folder.
50 |
51 | >>REMEMBER!
52 | You have to change the GraphQL uri in the Apollo Client and the WebSocket uri accordingly!
53 |
54 | You may also need to set your favicon!
55 |
56 | ## Built With
57 | >> FRONT-END
58 |
59 | * [Vue](https://github.com/vuejs/vue) - Progressive Javascript Framework for UIs
60 | * [Vuex](https://github.com/vuejs/vuex) - Flux State Management
61 | * [Vue-router](https://github.com/vuejs/vue-router) - SPA Routing
62 | * [Vuetify](https://github.com/vuetifyjs/vuetify) - Material UI Design
63 | * [Vue-Apollo](https://github.com/Akryum/vue-apollo) - Integration for Vue/Apollo/GraphQL
64 |
65 | >> BACK-END
66 | * [GraphQL](http://graphql.org/) - A Query Language for APIs
67 | * [Express](http://expressjs.com/) - Fast minimalist web framework for NodeJS
68 | * [NodeJS](https://github.com/nodejs/node) - JavaScript runtime environment
69 |
70 | >> DATABASE
71 | * [Mongoose](http://mongoosejs.com/) - ORM for MongoDB
72 | * [MongoDB](http://www.mongodb.com) - No-SQL database
73 |
74 | >> DEVTOOLS
75 | * [Babel-watch](https://github.com/kmagiera/babel-watch) - Hot Reload for Babel-Node Apps
76 |
77 | ## Authors
78 |
79 | * **Lucas Otero** - *Initial work* - [Romucci](https://github.com/romucci)
80 |
81 | ## License
82 |
83 | This project is licensed under the [MIT](https://opensource.org/licenses/MIT) License.
84 |
85 | ## Acknowledgments
86 |
87 | I have compiled all the different technologies I have learnt to love and put them all together in a simple-to-start-with package!
88 | Hope you love it too!
--------------------------------------------------------------------------------
/client/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "boilerplate-vue-apollo-graphql-express-mongodb-client-side",
3 | "version": "1.0.0",
4 | "description": "Client Side for Boilerplate",
5 | "author": "Lucas Otero",
6 | "scripts": {
7 | "dev": "webpack-dev-server --inline --progress --config build/webpack.dev.conf.js",
8 | "start": "npm run dev",
9 | "lint": "eslint --ext .js,.vue src",
10 | "build": "node build/build.js"
11 | },
12 | "dependencies": {
13 | "apollo-cache-inmemory": "^1.1.12",
14 | "apollo-client": "^2.2.8",
15 | "apollo-link": "^1.2.1",
16 | "apollo-link-context": "^1.0.8",
17 | "apollo-link-error": "^1.1.0",
18 | "apollo-link-http": "^1.5.3",
19 | "apollo-link-ws": "^1.0.8",
20 | "apollo-utilities": "^1.0.16",
21 | "graphql": "^0.13.2",
22 | "graphql-tag": "^2.8.0",
23 | "subscriptions-transport-ws": "^0.9.12",
24 | "vue": "^2.5.2",
25 | "vue-apollo": "^3.0.0-beta.5",
26 | "vue-router": "^3.0.1",
27 | "vuetify": "^1.1.8",
28 | "vuex": "^3.0.1"
29 | },
30 | "devDependencies": {
31 | "autoprefixer": "^7.1.2",
32 | "babel-core": "^6.22.1",
33 | "babel-eslint": "^8.2.1",
34 | "babel-helper-vue-jsx-merge-props": "^2.0.3",
35 | "babel-loader": "^7.1.1",
36 | "babel-plugin-syntax-jsx": "^6.18.0",
37 | "babel-plugin-transform-runtime": "^6.22.0",
38 | "babel-plugin-transform-vue-jsx": "^3.5.0",
39 | "babel-preset-env": "^1.3.2",
40 | "babel-preset-stage-2": "^6.22.0",
41 | "chalk": "^2.0.1",
42 | "copy-webpack-plugin": "^4.0.1",
43 | "css-loader": "^0.28.0",
44 | "eslint": "^4.15.0",
45 | "eslint-config-standard": "^10.2.1",
46 | "eslint-friendly-formatter": "^3.0.0",
47 | "eslint-loader": "^1.7.1",
48 | "eslint-plugin-import": "^2.7.0",
49 | "eslint-plugin-node": "^5.2.0",
50 | "eslint-plugin-promise": "^3.4.0",
51 | "eslint-plugin-standard": "^3.0.1",
52 | "eslint-plugin-vue": "^4.0.0",
53 | "extract-text-webpack-plugin": "^3.0.0",
54 | "file-loader": "^1.1.4",
55 | "friendly-errors-webpack-plugin": "^1.6.1",
56 | "html-webpack-plugin": "^2.30.1",
57 | "node-notifier": "^5.1.2",
58 | "optimize-css-assets-webpack-plugin": "^3.2.0",
59 | "ora": "^1.2.0",
60 | "portfinder": "^1.0.13",
61 | "postcss-import": "^11.0.0",
62 | "postcss-loader": "^2.0.8",
63 | "postcss-url": "^7.2.1",
64 | "rimraf": "^2.6.0",
65 | "semver": "^5.3.0",
66 | "shelljs": "^0.7.6",
67 | "uglifyjs-webpack-plugin": "^1.1.1",
68 | "url-loader": "^0.5.8",
69 | "vue-loader": "^13.3.0",
70 | "vue-style-loader": "^3.0.1",
71 | "vue-template-compiler": "^2.5.2",
72 | "webpack": "^3.6.0",
73 | "webpack-bundle-analyzer": "^2.9.0",
74 | "webpack-dev-server": "^2.9.1",
75 | "webpack-merge": "^4.1.0"
76 | },
77 | "engines": {
78 | "node": ">= 6.0.0",
79 | "npm": ">= 3.0.0"
80 | },
81 | "browserslist": [
82 | "> 1%",
83 | "last 2 versions",
84 | "not ie <= 8"
85 | ]
86 | }
87 |
--------------------------------------------------------------------------------
/client/build/utils.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const config = require('../config')
4 | const ExtractTextPlugin = require('extract-text-webpack-plugin')
5 | const packageConfig = require('../package.json')
6 |
7 | exports.assetsPath = function (_path) {
8 | const assetsSubDirectory = process.env.NODE_ENV === 'production'
9 | ? config.build.assetsSubDirectory
10 | : config.dev.assetsSubDirectory
11 |
12 | return path.posix.join(assetsSubDirectory, _path)
13 | }
14 |
15 | exports.cssLoaders = function (options) {
16 | options = options || {}
17 |
18 | const cssLoader = {
19 | loader: 'css-loader',
20 | options: {
21 | sourceMap: options.sourceMap
22 | }
23 | }
24 |
25 | const postcssLoader = {
26 | loader: 'postcss-loader',
27 | options: {
28 | sourceMap: options.sourceMap
29 | }
30 | }
31 |
32 | // generate loader string to be used with extract text plugin
33 | function generateLoaders (loader, loaderOptions) {
34 | const loaders = options.usePostCSS ? [cssLoader, postcssLoader] : [cssLoader]
35 |
36 | if (loader) {
37 | loaders.push({
38 | loader: loader + '-loader',
39 | options: Object.assign({}, loaderOptions, {
40 | sourceMap: options.sourceMap
41 | })
42 | })
43 | }
44 |
45 | // Extract CSS when that option is specified
46 | // (which is the case during production build)
47 | if (options.extract) {
48 | return ExtractTextPlugin.extract({
49 | use: loaders,
50 | fallback: 'vue-style-loader'
51 | })
52 | } else {
53 | return ['vue-style-loader'].concat(loaders)
54 | }
55 | }
56 |
57 | // https://vue-loader.vuejs.org/en/configurations/extract-css.html
58 | return {
59 | css: generateLoaders(),
60 | postcss: generateLoaders(),
61 | less: generateLoaders('less'),
62 | sass: generateLoaders('sass', { indentedSyntax: true }),
63 | scss: generateLoaders('sass'),
64 | stylus: generateLoaders('stylus'),
65 | styl: generateLoaders('stylus')
66 | }
67 | }
68 |
69 | // Generate loaders for standalone style files (outside of .vue)
70 | exports.styleLoaders = function (options) {
71 | const output = []
72 | const loaders = exports.cssLoaders(options)
73 |
74 | for (const extension in loaders) {
75 | const loader = loaders[extension]
76 | output.push({
77 | test: new RegExp('\\.' + extension + '$'),
78 | use: loader
79 | })
80 | }
81 |
82 | return output
83 | }
84 |
85 | exports.createNotifierCallback = () => {
86 | const notifier = require('node-notifier')
87 |
88 | return (severity, errors) => {
89 | if (severity !== 'error') return
90 |
91 | const error = errors[0]
92 | const filename = error.file && error.file.split('!').pop()
93 |
94 | notifier.notify({
95 | title: packageConfig.name,
96 | message: severity + ': ' + error.name,
97 | subtitle: filename || '',
98 | icon: path.join(__dirname, 'logo.png')
99 | })
100 | }
101 | }
102 |
--------------------------------------------------------------------------------
/server/src/server.js:
--------------------------------------------------------------------------------
1 | // IMPORTS
2 | import express from 'express'
3 | import mongoose from 'mongoose'
4 | import morgan from 'morgan'
5 | import cors from 'cors'
6 | import path from 'path'
7 | /* UNCOMMENT FOR HTTP2
8 |
9 | import fs from 'fs'
10 | import spdy from 'spdy'
11 | import favicon from 'serve-favicon'
12 |
13 | */
14 | import serveStatic from 'serve-static'
15 | import { createServer } from 'http'
16 | import { mergeTypes, mergeResolvers, fileLoader } from 'merge-graphql-schemas'
17 | import { execute, subscribe } from 'graphql';
18 | import { SubscriptionServer } from 'subscriptions-transport-ws';
19 | import { graphiqlExpress, graphqlExpress } from 'apollo-server-express'
20 | import { makeExecutableSchema } from 'graphql-tools'
21 |
22 | // CONFIG
23 | require('dotenv').config()
24 | const app = express()
25 | const PORT = process.env.PORT || 8081
26 |
27 | // MONGODB MODELS
28 | import models from './models'
29 |
30 | // GRAPHQL TYPES-RESOLVERS
31 | const typeDefs = mergeTypes(fileLoader(path.join(__dirname, './graphql/types')))
32 | const resolvers = mergeResolvers(fileLoader(path.join(__dirname, './graphql/resolvers')))
33 |
34 | // DATABASE CONNECTION
35 | mongoose.Promise = global.Promise
36 | mongoose
37 | .connect(`YOUR_MONGODB_CONNECTION_STRING`)
38 | .then(() => {
39 | console.log(`Connection to database successful!`)
40 | console.log('----------------------------------')
41 | })
42 | .catch(err => console.log(`Error connecting to database: ${err}`))
43 |
44 | // LOGGER
45 | app.use(morgan('dev'))
46 |
47 | // CORS
48 | app.use(cors('*'))
49 |
50 | // SERVE STATIC FILES
51 | app.use(serveStatic(__dirname + "/dist"));
52 | app.use('*', serveStatic(__dirname + "/dist"))
53 | // app.use(favicon(path.join(__dirname, 'dist', 'static', 'favicon.png')))
54 |
55 |
56 | // GRAPHQL SETUP
57 | const schema = makeExecutableSchema({
58 | typeDefs,
59 | resolvers
60 | })
61 |
62 | app.use('/graphql', express.json(), graphqlExpress({ schema, context: models }))
63 | app.use('/graphiql', graphiqlExpress({
64 | endpointURL: '/graphql',
65 | subscriptionsEndpoint: `ws://localhost:8081/subscriptions`
66 | }))
67 |
68 | /* UNCOMMENT FOR HTTPS2
69 |
70 | const options = {
71 | key: fs.readFileSync('__YOUR_KEY_FILE__'),
72 | cert: fs.readFileSync('__YOUR_CERT_FILE__'),
73 | passphrase: '__YOUR_PASS_PHRASE__'
74 | }
75 | // CREATE SERVER WITH HTTP/2
76 | const server =
77 | spdy.createServer(options, app)
78 | .listen(process.env.PORT, () => {
79 | new SubscriptionServer({ execute, subscribe, schema }, { server, path: '/subscriptions' })
80 | console.log(`Server started in this URL: https://localhost:${process.env.PORT}/graphiql`)}
81 | )
82 | */
83 |
84 | // CREATE SERVER WITH HTTP
85 | const ws = createServer(app);
86 | ws.listen(PORT, () => {
87 | console.log(`Apollo Server is now running on http://localhost:${PORT}`)
88 | // Set up the WebSocket for handling GraphQL subscriptions
89 | new SubscriptionServer({
90 | execute,
91 | subscribe,
92 | schema
93 | }, {
94 | server: ws,
95 | path: '/subscriptions',
96 | })
97 | })
98 |
--------------------------------------------------------------------------------
/client/build/webpack.dev.conf.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const utils = require('./utils')
3 | const webpack = require('webpack')
4 | const config = require('../config')
5 | const merge = require('webpack-merge')
6 | const path = require('path')
7 | const baseWebpackConfig = require('./webpack.base.conf')
8 | const CopyWebpackPlugin = require('copy-webpack-plugin')
9 | const HtmlWebpackPlugin = require('html-webpack-plugin')
10 | const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin')
11 | const portfinder = require('portfinder')
12 |
13 | const HOST = process.env.HOST
14 | const PORT = process.env.PORT && Number(process.env.PORT)
15 |
16 | const devWebpackConfig = merge(baseWebpackConfig, {
17 | module: {
18 | rules: utils.styleLoaders({ sourceMap: config.dev.cssSourceMap, usePostCSS: true })
19 | },
20 | // cheap-module-eval-source-map is faster for development
21 | devtool: config.dev.devtool,
22 |
23 | // these devServer options should be customized in /config/index.js
24 | devServer: {
25 | clientLogLevel: 'warning',
26 | historyApiFallback: {
27 | rewrites: [
28 | { from: /.*/, to: path.posix.join(config.dev.assetsPublicPath, 'index.html') },
29 | ],
30 | },
31 | hot: true,
32 | contentBase: false, // since we use CopyWebpackPlugin.
33 | compress: true,
34 | host: HOST || config.dev.host,
35 | port: PORT || config.dev.port,
36 | open: config.dev.autoOpenBrowser,
37 | overlay: config.dev.errorOverlay
38 | ? { warnings: false, errors: true }
39 | : false,
40 | publicPath: config.dev.assetsPublicPath,
41 | proxy: config.dev.proxyTable,
42 | quiet: true, // necessary for FriendlyErrorsPlugin
43 | watchOptions: {
44 | poll: config.dev.poll,
45 | }
46 | },
47 | plugins: [
48 | new webpack.DefinePlugin({
49 | 'process.env': require('../config/dev.env')
50 | }),
51 | new webpack.HotModuleReplacementPlugin(),
52 | new webpack.NamedModulesPlugin(), // HMR shows correct file names in console on update.
53 | new webpack.NoEmitOnErrorsPlugin(),
54 | // https://github.com/ampedandwired/html-webpack-plugin
55 | new HtmlWebpackPlugin({
56 | filename: 'index.html',
57 | template: 'index.html',
58 | inject: true
59 | }),
60 | // copy custom static assets
61 | new CopyWebpackPlugin([
62 | {
63 | from: path.resolve(__dirname, '../static'),
64 | to: config.dev.assetsSubDirectory,
65 | ignore: ['.*']
66 | }
67 | ])
68 | ]
69 | })
70 |
71 | module.exports = new Promise((resolve, reject) => {
72 | portfinder.basePort = process.env.PORT || config.dev.port
73 | portfinder.getPort((err, port) => {
74 | if (err) {
75 | reject(err)
76 | } else {
77 | // publish the new Port, necessary for e2e tests
78 | process.env.PORT = port
79 | // add port to devServer config
80 | devWebpackConfig.devServer.port = port
81 |
82 | // Add FriendlyErrorsPlugin
83 | devWebpackConfig.plugins.push(new FriendlyErrorsPlugin({
84 | compilationSuccessInfo: {
85 | messages: [`Your application is running here: http://${devWebpackConfig.devServer.host}:${port}`],
86 | },
87 | onErrors: config.dev.notifyOnErrors
88 | ? utils.createNotifierCallback()
89 | : undefined
90 | }))
91 |
92 | resolve(devWebpackConfig)
93 | }
94 | })
95 | })
96 |
--------------------------------------------------------------------------------
/client/build/webpack.prod.conf.js:
--------------------------------------------------------------------------------
1 | 'use strict'
2 | const path = require('path')
3 | const utils = require('./utils')
4 | const webpack = require('webpack')
5 | const config = require('../config')
6 | const merge = require('webpack-merge')
7 | const baseWebpackConfig = require('./webpack.base.conf')
8 | const CopyWebpackPlugin = require('copy-webpack-plugin')
9 | const HtmlWebpackPlugin = require('html-webpack-plugin')
10 | const ExtractTextPlugin = require('extract-text-webpack-plugin')
11 | const OptimizeCSSPlugin = require('optimize-css-assets-webpack-plugin')
12 | const UglifyJsPlugin = require('uglifyjs-webpack-plugin')
13 |
14 | const env = require('../config/prod.env')
15 |
16 | const webpackConfig = merge(baseWebpackConfig, {
17 | module: {
18 | rules: utils.styleLoaders({
19 | sourceMap: config.build.productionSourceMap,
20 | extract: true,
21 | usePostCSS: true
22 | })
23 | },
24 | devtool: config.build.productionSourceMap ? config.build.devtool : false,
25 | output: {
26 | path: config.build.assetsRoot,
27 | filename: utils.assetsPath('js/[name].[chunkhash].js'),
28 | chunkFilename: utils.assetsPath('js/[id].[chunkhash].js')
29 | },
30 | plugins: [
31 | // http://vuejs.github.io/vue-loader/en/workflow/production.html
32 | new webpack.DefinePlugin({
33 | 'process.env': env
34 | }),
35 | new UglifyJsPlugin({
36 | uglifyOptions: {
37 | compress: {
38 | warnings: false
39 | }
40 | },
41 | sourceMap: config.build.productionSourceMap,
42 | parallel: true
43 | }),
44 | // extract css into its own file
45 | new ExtractTextPlugin({
46 | filename: utils.assetsPath('css/[name].[contenthash].css'),
47 | // Setting the following option to `false` will not extract CSS from codesplit chunks.
48 | // Their CSS will instead be inserted dynamically with style-loader when the codesplit chunk has been loaded by webpack.
49 | // It's currently set to `true` because we are seeing that sourcemaps are included in the codesplit bundle as well when it's `false`,
50 | // increasing file size: https://github.com/vuejs-templates/webpack/issues/1110
51 | allChunks: true,
52 | }),
53 | // Compress extracted CSS. We are using this plugin so that possible
54 | // duplicated CSS from different components can be deduped.
55 | new OptimizeCSSPlugin({
56 | cssProcessorOptions: config.build.productionSourceMap
57 | ? { safe: true, map: { inline: false } }
58 | : { safe: true }
59 | }),
60 | // generate dist index.html with correct asset hash for caching.
61 | // you can customize output by editing /index.html
62 | // see https://github.com/ampedandwired/html-webpack-plugin
63 | new HtmlWebpackPlugin({
64 | filename: config.build.index,
65 | template: 'index.html',
66 | inject: true,
67 | minify: {
68 | removeComments: true,
69 | collapseWhitespace: true,
70 | removeAttributeQuotes: true
71 | // more options:
72 | // https://github.com/kangax/html-minifier#options-quick-reference
73 | },
74 | // necessary to consistently work with multiple chunks via CommonsChunkPlugin
75 | chunksSortMode: 'dependency'
76 | }),
77 | // keep module.id stable when vendor modules does not change
78 | new webpack.HashedModuleIdsPlugin(),
79 | // enable scope hoisting
80 | new webpack.optimize.ModuleConcatenationPlugin(),
81 | // split vendor js into its own file
82 | new webpack.optimize.CommonsChunkPlugin({
83 | name: 'vendor',
84 | minChunks (module) {
85 | // any required modules inside node_modules are extracted to vendor
86 | return (
87 | module.resource &&
88 | /\.js$/.test(module.resource) &&
89 | module.resource.indexOf(
90 | path.join(__dirname, '../node_modules')
91 | ) === 0
92 | )
93 | }
94 | }),
95 | // extract webpack runtime and module manifest to its own file in order to
96 | // prevent vendor hash from being updated whenever app bundle is updated
97 | new webpack.optimize.CommonsChunkPlugin({
98 | name: 'manifest',
99 | minChunks: Infinity
100 | }),
101 | // This instance extracts shared chunks from code splitted chunks and bundles them
102 | // in a separate chunk, similar to the vendor chunk
103 | // see: https://webpack.js.org/plugins/commons-chunk-plugin/#extra-async-commons-chunk
104 | new webpack.optimize.CommonsChunkPlugin({
105 | name: 'app',
106 | async: 'vendor-async',
107 | children: true,
108 | minChunks: 3
109 | }),
110 |
111 | // copy custom static assets
112 | new CopyWebpackPlugin([
113 | {
114 | from: path.resolve(__dirname, '../static'),
115 | to: config.build.assetsSubDirectory,
116 | ignore: ['.*']
117 | }
118 | ])
119 | ]
120 | })
121 |
122 | if (config.build.productionGzip) {
123 | const CompressionWebpackPlugin = require('compression-webpack-plugin')
124 |
125 | webpackConfig.plugins.push(
126 | new CompressionWebpackPlugin({
127 | asset: '[path].gz[query]',
128 | algorithm: 'gzip',
129 | test: new RegExp(
130 | '\\.(' +
131 | config.build.productionGzipExtensions.join('|') +
132 | ')$'
133 | ),
134 | threshold: 10240,
135 | minRatio: 0.8
136 | })
137 | )
138 | }
139 |
140 | if (config.build.bundleAnalyzerReport) {
141 | const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin
142 | webpackConfig.plugins.push(new BundleAnalyzerPlugin())
143 | }
144 |
145 | module.exports = webpackConfig
146 |
--------------------------------------------------------------------------------