Skip to content

Commit

Permalink
[add] new project
Browse files Browse the repository at this point in the history
  • Loading branch information
Simo-C3 committed Sep 6, 2021
0 parents commit 896960e
Show file tree
Hide file tree
Showing 25 changed files with 36,505 additions and 0 deletions.
16 changes: 16 additions & 0 deletions .babelrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"env": {
"test": {
"presets": [
[
"@babel/preset-env",
{
"targets": {
"node": "current"
}
}
]
]
}
}
}
13 changes: 13 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
20 changes: 20 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
module.exports = {
root: true,
env: {
browser: true,
node: true
},
parserOptions: {
parser: '@babel/eslint-parser',
requireConfigFile: false
},
extends: [
'@nuxtjs',
'plugin:nuxt/recommended',
'prettier'
],
plugins: [
],
// add your custom rules here
rules: {}
}
90 changes: 90 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# Created by .ignore support plugin (hsz.mobi)
### Node template
# Logs
/logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# Nuxt generate
dist

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless

# IDE / Editor
.idea

# Service worker
sw.*

# macOS
.DS_Store

# Vim swap files
*.swp
4 changes: 4 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"semi": false,
"singleQuote": true
}
207 changes: 207 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
# web

公式サイトのリニューアル版

# 役割分担
* Header:最終デザインがまだ
* Footer:もおん
* トップページ(pages/index.vue)
components/
* Top.vue:ko_suke
* AboutC3.vue:Kizuku
* AboutCommunity.vue:まつり
* CommunityLink.vue:オンコン
* Blog.vue:Kouichi_T
* C3について(pages/about/index.vue)
components/
*
* お知らせ一覧(pages/news/index.vue)
components/
*
* お知らせ詳細(pages/news/_id.vue)
components/
*
* 各コミュニティーページ(pages/community/_id.vue)
components/
*
* ブログ一覧(pages/blog/index.vue)
components/
*
* ブログ詳細(pages/blog/_id.vue)
components/
*
* お問い合わせ(pages/contact/index.vue)
components/
*

# デザイン

## デザイン
以下のリンクで色やサイズ等の情報が確認できる。  
[XD](https://xd.adobe.com/view/2ea8e9f6-2a78-4dc5-9ae5-4f44e2894818-7bfb/)

# CSS
## SCSSで値を変数化
今回は共通の値をCSSに値を直書きせず、SCSSで変数定義した値を使って、スタイルを記述していきます。変数定義場所は
```
~/assets/stylesheets/variables.scss
```
## **SCSSの使用に当たって**
初めての人が何人かいるので、いきなりSCSSはきついと思います。なので、今回の開発は慣れていない人にそれぞれ、慣れている人がサポート役で対応する形で行っていこうと思います。それぞれのすべきことを下に書いておきます。

**慣れている人**
* SCSSで各値の変数定義
* コードチェック

**慣れていない人**
* 役割部分のコーディング(スタイルの値はSCSSの変数を使う)
* 質問があるときや分からい時は担当の人に聞くか、シモに聞くか、他の分かる人に聞く。
* 完成したら担当の人にコードをチェックしてもらう。

## SCSSでの変数命名規則
プロパティー名 + 大きさ(small, large,...)・色(red,blue,...)
例)フォントの色を定義する場合

```
$color-red: #FF0;
```
例)フォントのサイズを定義する場合
```
$font-size-small: 15px;
```

# コンポーネント

## コンポーネントファイル
コンポーネントファイルはコンポーネントディレクトリ直下に作成

## コンポーネント命名規則
ページ名 + コンポーネント名
例)トップページのトップコンポーネント
```
topTop.vue
```

例)ブログ一覧ページのカード一覧コンポーネント
```
blogListCardList.vue
```
例)ブログ一覧ページのカードコンポーネント
```
blogListCard.vue
```

## コンポーネント制作注意点
* widthは100%

# 開発の流れ

### 0. 初めに
1. それぞれのデバイスにこのリポジトリをクローンする。
```
$ git clone <URL>
```
2. プロジェクトファイル直下で各モジュールをインストールする。
```
$ npm install
```
### 1. コードを書く
1. GitHubで自分の行う作業をissueに書く。

2. 1.で立てたissue番号でdevelopブランチからブランチを切る。例)issue番号が#15の場合:ブランチ名は`issue15`

3. 2.で切ったブランチにチェックアウトし、担当コンポーネントのファイルで作業を行う。

### 2. コードを書いたら(完成してなくてもよい。キリがよかったら)
1. 変更をステージする。
```
$ git add <ステージするファイル名>
```
複数ある場合はファイル名の間に空白を入れる。
```
$ git add <ファイル名> <ファイル名>
```

2. ステージした変更をコミットする。
```
$ git commit -m "[変更の種類] <変更内容>"
```

3. コミットした変更をプッシュする
```
$ git push origin <ブランチ名>
```

### 3. コードが完成したら(担当部分が完成)
1. 2.コードを書いたらを行う。
2. ブラウザーで[webリポジトリ](https://github.com/Kyutech-C3/web)にアクセスし、プルリクエストを出す。
3. プルリクエストがマージされたら作業終了


# Build Setup

```bash
# install dependencies
$ npm install

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

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

# generate static project
$ npm run generate
```

For detailed explanation on how things work, check out the [documentation](https://nuxtjs.org).

## Special Directories

You can create the following extra directories, some of which have special behaviors. Only `pages` is required; you can delete them if you don't want to use their functionality.

### `assets`

The assets directory contains your uncompiled assets such as Stylus or Sass files, images, or fonts.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/assets).

### `components`

The components directory contains your Vue.js components. Components make up the different parts of your page and can be reused and imported into your pages, layouts and even other components.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/components).

### `layouts`

Layouts are a great help when you want to change the look and feel of your Nuxt app, whether you want to include a sidebar or have distinct layouts for mobile and desktop.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/layouts).


### `pages`

This directory contains your application views and routes. Nuxt will read all the `*.vue` files inside this directory and setup Vue Router automatically.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/get-started/routing).

### `plugins`

The plugins directory contains JavaScript plugins that you want to run before instantiating the root Vue.js Application. This is the place to add Vue plugins and to inject functions or constants. Every time you need to use `Vue.use()`, you should create a file in `plugins/` and add its path to plugins in `nuxt.config.js`.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/plugins).

### `static`

This directory contains your static files. Each file inside this directory is mapped to `/`.

Example: `/static/robots.txt` is mapped as `/robots.txt`.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/static).

### `store`

This directory contains your Vuex store files. Creating a file in this directory automatically activates Vuex.

More information about the usage of this directory in [the documentation](https://nuxtjs.org/docs/2.x/directory-structure/store).
Empty file.
Empty file added components/Footer.vue
Empty file.
Empty file added components/Header.vue
Empty file.
22 changes: 22 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
module.exports = {
moduleNameMapper: {
'^@/(.*)$': '<rootDir>/$1',
'^~/(.*)$': '<rootDir>/$1',
'^vue$': 'vue/dist/vue.common.js'
},
moduleFileExtensions: [
'js',
'vue',
'json'
],
transform: {
'^.+\\.js$': 'babel-jest',
'.*\\.(vue)$': 'vue-jest'
},
collectCoverage: true,
collectCoverageFrom: [
'<rootDir>/components/**/*.vue',
'<rootDir>/pages/**/*.vue'
],
testEnvironment: 'jsdom'
}
12 changes: 12 additions & 0 deletions jsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"~/*": ["./*"],
"@/*": ["./*"],
"~~/*": ["./*"],
"@@/*": ["./*"]
}
},
"exclude": ["node_modules", ".nuxt", "dist"]
}
Loading

0 comments on commit 896960e

Please sign in to comment.