chore: github template (#187)

* chore: remove vue-cli structure * update README * fix lint
nuxt-community · Feb 3, 2021 · 4c8a4df · 4c8a4df
1 parent 8fa47e8
commit 4c8a4df
Show file tree

Hide file tree

Showing 26 changed files with 36 additions and 68 deletions.
diff --git a/template/.editorconfig → .editorconfig b/template/.editorconfig → .editorconfig
diff --git a/template/.eslintrc.js → .eslintrc.js b/template/.eslintrc.js → .eslintrc.js
diff --git a/template/.gitignore → .gitignore b/template/.gitignore → .gitignore
diff --git a/README.md b/README.md
@@ -5,19 +5,36 @@
 
 > [ExpressJS](http://expressjs.com/) + [Nuxt.js](https://nuxtjs.org) = :zap:
 
-Live Demo: [https://codesandbox.io/s/github/nuxt-community/express-template/tree/demo](https://codesandbox.io/s/github/nuxt-community/express-template/tree/demo)
+Live Demo: [https://codesandbox.io/s/github/nuxt-community/express-template](https://codesandbox.io/s/github/nuxt-community/express-template)
 
 ## Installation
 
-This is a project template for [vue-cli](https://github.com/vuejs/vue-cli).
+This is a template project, clone or fork the repo and start your project
 
 ```bash
-vue init nuxt-community/express-template <project-name>
+git clone https://github.com/nuxt-community/express-template.git <project-name>
 cd <project-name> # move to your project
-npm install # or yarn install
+yarn install # or npm install
 ```
 
-> Make sure to use a version of vue-cli >= 2.1 (vue -V).
+## Build Setup
+
+```bash
+# install dependencies
+$ yarn install
+
+# serve with hot reload at localhost:3000
+$ yarn dev
+
+# build for production and launch server
+$ yarn build
+$ yarn start
+
+# generate static project
+$ yarn generate
+```
+
+For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
 
 ## ExpressJS Changes
 
@@ -47,3 +64,5 @@ npm install # or yarn install
 - [ExpressJS license](https://github.com/expressjs/express/blob/master/LICENSE)
 - [NuxtJS license](https://github.com/nuxt/nuxt.js/blob/master/LICENSE.md)
 - [VueJS license](https://github.com/vuejs/vue/blob/master/LICENSE)
+
+
diff --git a/template/api/index.js → api/index.js b/template/api/index.js → api/index.js
@@ -18,6 +18,7 @@ module.exports = app
 if (require.main === module) {
   const port = process.env.PORT || 3001
   app.listen(port, () => {
+    // eslint-disable-next-line no-console
     console.log(`API server listening on port ${port}`)
   })
 }
diff --git a/template/api/routes/test.js → api/routes/test.js b/template/api/routes/test.js → api/routes/test.js
diff --git a/template/api/routes/users.js → api/routes/users.js b/template/api/routes/users.js → api/routes/users.js
diff --git a/template/assets/README.md → assets/README.md b/template/assets/README.md → assets/README.md
diff --git a/template/components/Logo.vue → components/Logo.vue b/template/components/Logo.vue → components/Logo.vue
@@ -1,4 +1,3 @@
-{{{{raw}}}}
 <template>
   <svg class="NuxtLogo" width="245" height="180" viewBox="0 0 452 342" xmlns="http://www.w3.org/2000/svg">
     <path
@@ -15,7 +14,6 @@
     />
   </svg>
 </template>
-{{{{/raw}}}}
 
 <style>
 .NuxtLogo {

diff --git a/template/components/README.md → components/README.md b/template/components/README.md → components/README.md
diff --git a/template/layouts/README.md → layouts/README.md b/template/layouts/README.md → layouts/README.md
diff --git a/template/layouts/default.vue → layouts/default.vue b/template/layouts/default.vue → layouts/default.vue
@@ -1,10 +1,8 @@
-{{{{raw}}}}
 <template>
   <div>
     <Nuxt />
   </div>
 </template>
-{{{{/raw}}}}
 
 <style>
 html {

diff --git a/template/layouts/error.vue → layouts/error.vue b/template/layouts/error.vue → layouts/error.vue
@@ -1,4 +1,3 @@
-{{{{raw}}}}
 <template>
   <section class="container">
     <div>
@@ -9,16 +8,21 @@
       <h2 class="info">
         {{ error.message }}
       </h2>
-      <nuxt-link class="button" to="/" v-if="error.statusCode === 404">
+      <nuxt-link v-if="error.statusCode === 404" class="button" to="/">
         Homepage
       </nuxt-link>
     </div>
   </section>
 </template>
-{{{{/raw}}}}
+
 <script>
 export default {
-  props: ['error']
+  props: {
+    error: {
+      type: Object,
+      default: () => ({})
+    }
+  }
 }
 </script>
 

diff --git a/meta.js b/meta.js
diff --git a/template/middleware/README.md → middleware/README.md b/template/middleware/README.md → middleware/README.md
diff --git a/template/nuxt.config.js → nuxt.config.js b/template/nuxt.config.js → nuxt.config.js
@@ -46,7 +46,7 @@ export default {
   */
   buildModules: [
     // Doc: https://github.com/nuxt-community/eslint-module
-    '@nuxtjs/eslint-module',
+    '@nuxtjs/eslint-module'
   ],
 
   /*

diff --git a/template/package.json → package.json b/template/package.json → package.json
@@ -1,8 +1,6 @@
 {
-  "name": "name",
+  "name": "nuxt-express",
   "version": "1.0.0",
-  "description": "{{ description }}",
-  "author": "{{ author }}",
   "private": true,
   "scripts": {
     "dev": "nuxt",

diff --git a/template/pages/README.md → pages/README.md b/template/pages/README.md → pages/README.md
diff --git a/template/pages/index.vue → pages/index.vue b/template/pages/index.vue → pages/index.vue
@@ -1,4 +1,3 @@
-{{{{raw}}}}
 <template>
   <div class="container">
     <div>
@@ -38,7 +37,7 @@
     </div>
   </div>
 </template>
-{{{{/raw}}}}
+
 <script>
 export default {
   async asyncData ({ $http }) {

diff --git a/template/pages/users/_id.vue → pages/users/_id.vue b/template/pages/users/_id.vue → pages/users/_id.vue
@@ -1,4 +1,3 @@
-{{{{raw}}}}
 <template>
   <section class="container">
     <div>
@@ -15,7 +14,6 @@
     </div>
   </section>
 </template>
-{{{{/raw}}}}
 
 <script>
 export default {

diff --git a/template/pages/users/index.vue → pages/users/index.vue b/template/pages/users/index.vue → pages/users/index.vue
@@ -1,4 +1,3 @@
-{{{{raw}}}}
 <template>
   <section class="container">
     <div>
@@ -19,7 +18,6 @@
     </div>
   </section>
 </template>
-{{{{/raw}}}}
 
 <script>
 export default {

diff --git a/template/plugins/README.md → plugins/README.md b/template/plugins/README.md → plugins/README.md
diff --git a/template/static/README.md → static/README.md b/template/static/README.md → static/README.md
diff --git a/template/static/favicon.ico → static/favicon.ico b/template/static/favicon.ico → static/favicon.ico
diff --git a/template/store/README.md → store/README.md b/template/store/README.md → store/README.md
diff --git a/template/README.md b/template/README.md