Git Product home page Git Product logo

nuxt-app-on-docker's Introduction

Nuxt App on Docker

Recommended Development Environment

NAME TYPE COMMENT
EditorConfig Shared Editor Settings EditorConfig for VS Code is released.
Visual Studio Code (VS Code) Editor

How to Setup

The following are how to setup for macOS in development environment.

  1. Install Docker and docker-compose to build containers to run this project on your local.
  2. Run docker-compose up to create and run containers.
  3. You can develop it if you access http://localhost:3000.

Docker commands

  • docker run -it --rm <container id> sh: Create and connect container
  • docker run -it --rm <container id> --start: Run yarn && yarn nuxt
  • docker run -it --rm <container id> --build: Run yarn build

Commonly Used Commands

`docker build -f <Dockerfile path> <project root path(default: .)>`: Build Docker
`docker rmi <Docker image id>`: Remove Docker image
`docker rm <container id>`: Remove container

`docker exec -it <container id> <run command>`: Connect running contaier
options
  `--rm`: Delete the container when you exit the container
  `-v <Mac absolute path>:<Container absolute path>`: Synchronize specified directories
  `-p <Mac port>:<Container port>`: Synchronize specified port
  `--name`: Name container

Environments

The following is environments in this project.

ENVIRONMENT NAME FOR DOMAIN COMMENT
development Localhost localhost:3000

Installation

  • Choose between integrated server-side frameworks: None (Nuxt default server)
  • Check the features needed for your project: PWA, Axios
  • Choose your favorite UI framework: Element UI
  • Choose your favorite test framework: None

Commit Rules

  1. ブランチの運用
    1. ブランチの運用フローとして GitHub Flow を採用する
    2. master ブランチをデフォルトブランチとして用いる
    3. 機能開発/変更/修正する場合は feature/ をブランチ名の接頭辞として用いる
    4. ブランチ名の各単語は - でつなぐチェーンケースを用いる
    5. ブランチ名は作業内容を明確に表す
    6. ブランチ名は動詞の原形から書き始めを原則とする
    7. 他ブランチへのマージは GitHub のプルリクエスト機能を用いる
  2. コミットメッセージ
    • コミットメッセージは、以下に示す形式に従うこと
[<COMMIT_TYPE>] <SUMMARY>

- <DESCRIPTION>
- <DESCRIPTION>

<COMMIT_TYPE>

コミットの種類を表す文字列で、以下の文字列から選択する。

  • Add:機能追加
  • Fix:バグ修正
  • Change:破壊的変更
  • Clean:リファクタ
  • Remove:不要になったファイルやライブラリの削除

Examples

  • [Add] Implement to sort tasks on edit page

BAD

  • [Add]Implement to sort tasks on edit page
  • [Add] implement to sort tasks on edit page
  • [ADD] Implement to sort tasks on edit page
  • Add Implement to sort tasks on edit page
  • Add: Implement to sort tasks on edit page
  • [Add] Implement to sort tasks on edit page.

<SUMMARY>

コミットの要約。大文字から書き始め、文末にピリオド . を用いない。

<DESCRIPTION>(任意)

コミットの内容をより明確にし、レビューする人の負担を少なくする。3行目からコミット内容を箇条書き - で表す。 箇条書きがかなりの数になる場合は、コミット分割するべきである。

Example

[Add] Implement to sort tasks on edit page 

- Implement XXXXXX module 
- Add XXXXX component

GitHub Pullrequest

  • タイトルはブランチ名とほぼ同じものを採用し、大文字から始めること
  • テンプレートに従って記述すること

Examples

Branch Name

  • feature/implement-to-sort-tasks-on-edit-page

PR Title:

  • Implement to sort tasks on edit page

PR Body:

## New Features
- Implement XXXXXX module 
- Add XXXXX component

nuxt-app-on-docker's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.