Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typescript-nuxtjs-boilerplate/typescript-nuxtjs-boilerplate
:bento: Nuxt.js with TypeScript and Run with docker and docker-compose 🐶🦄🔥 visit: https://typescript-nuxtjs-boilerplate.netlify.com/example
https://github.com/typescript-nuxtjs-boilerplate/typescript-nuxtjs-boilerplate
docker docker-compose eslint gtm jest nuxtjs pug scss sentry typescript vee-validate vue-awesome-swiper vue-lazyload vue-scrollto vuejs vuex
Last synced: about 1 month ago
JSON representation
:bento: Nuxt.js with TypeScript and Run with docker and docker-compose 🐶🦄🔥 visit: https://typescript-nuxtjs-boilerplate.netlify.com/example
- Host: GitHub
- URL: https://github.com/typescript-nuxtjs-boilerplate/typescript-nuxtjs-boilerplate
- Owner: typescript-nuxtjs-boilerplate
- License: mit
- Created: 2019-07-09T07:14:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T02:43:31.000Z (3 months ago)
- Last Synced: 2024-10-01T06:36:47.869Z (about 1 month ago)
- Topics: docker, docker-compose, eslint, gtm, jest, nuxtjs, pug, scss, sentry, typescript, vee-validate, vue-awesome-swiper, vue-lazyload, vue-scrollto, vuejs, vuex
- Language: Vue
- Homepage: https://typescript-nuxtjs-boilerplate-docs.netlify.com/
- Size: 11.3 MB
- Stars: 58
- Watchers: 4
- Forks: 10
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# :bento: typescript-nuxtjs-boilerplate
`typescript-nuxtjs-boilerplate` は **Nuxt.js** で **TypeScript** を使うためのボイラープレートになります 🦑
Example url: [https://typescript-nuxtjs-boilerplate.netlify.com/example](https://typescript-nuxtjs-boilerplate.netlify.com/example)
---
## ⛑ Requirements
* Node.js v10+ おすすめは `v10.16.0` です
## 💾 Install
First, clone the repo via git:
`git submodule` でサンプルを書いているので、以下のように `git clone` してください
```bash
$ git clone --recursive [email protected]:typescript-nuxtjs-boilerplate/typescript-nuxtjs-boilerplate.git
```
### Install yarn
**for mac**
```bash
$ brew install yarn
```
**for windows**
```sh
# for Windows (with Chocolatey)
$ choco install yarn
```
[Use installer](https://yarnpkg.com/lang/en/docs/install/#windows-tab)
### Install dependencies
Using yarn:
```bash
yarn install
```
## 🔌 Serve with hot reload at localhost:4000
Nuxt のデフォルトのポートは `3000` ですが、他のプロセスにバッティングするケースが多いので、 `4000` にしています
```bash
$ yarn run dev
```
or
`local` は `dev` のエイリアスです
```bash
$ yarn run local
```
and run mock server for examples
そしてモックサーバーも別のプロセスとして起動させます
```bash
$ node ./tools/server.js
```
`5000` 番ポートで起動します
## 🕹 Build for production on docker and launch server
本番用の `docker` ビルドは以下になります
```bash
$ yarn run build:docker
$ yarn start
```
## 💻 Build for production and `SPA mode`
```bash
$ yarn run build:static
```
It will be published in the `dist` directory
For detailed explanation on how things work, checkout [Nuxt.js docs](https://nuxtjs.org).
## :blue_book: Example Links
[サンプル集 - typescript-nuxtjs-boilerplate-docs](https://typescript-nuxtjs-boilerplate-docs.netlify.com/#/nuxt/examples)
## 🖥 npm-scripts
[npm scriptsの解説 - typescript-nuxtjs-boilerplate-docs](https://typescript-nuxtjs-boilerplate-docs.netlify.com/#/nuxt/npm-scripts)
## 📚 Docs
`typescript-nuxtjs-boilerplate` のドキュメントです [docs and guides here](https://typescript-nuxtjs-boilerplate-docs.netlify.com/#/)
## ⚙️ Maintainers
- [hisasann](https://github.com/hisasann)
## 🍜 License
MIT © [hisasann](https://github.com/hisasann)
