Merge pull request #2 from gameclub000/feature-initialize

构建基础项目框架

.babelrc

@@ -0,0 +1,13 @@
+{
+    "env": {
+        "test": {
+            "presets": ["@babel/preset-env", "@babel/react", "next/babel"]
+        },
+        "development": {
+            "presets": ["next/babel"]
+        },
+        "production": {
+            "presets": ["next/babel"]
+        }
+    }
+}

.gitignore

@@ -0,0 +1,34 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# vercel
+.vercel

CHANGELOG

@@ -0,0 +1 @@
+* 构建基础项目框架

Dockerfile

@@ -0,0 +1,11 @@
+FROM node:14.9.0
+
+WORKDIR /app
+
+COPY ./ /app
+
+RUN yarn install
+
+RUN yarn build
+
+CMD ["yarn", "start"]

Dockerfile.dev

@@ -0,0 +1,9 @@
+FROM node:14.9.0
+
+WORKDIR /app
+
+COPY ./ /app
+
+RUN yarn install
+
+CMD ["yarn", "dev"]

README.md

@@ -1 +1,45 @@
-# Bill
+# Bill
+
+一个简易的记账本应用程序
+
+## System Requirements
+
+|Env| MacOS:Docker | Ubuntu |
+| ------ | ------ |------ |
+|Memory|2 GB RAM|2 GB RAM|
+|Free space|10 GB|10 GB|
+
+## Getting Started
+
+请根据以下指示运行项目：
+
+### MacOS(Docker)
+
+1. 安装 [Docker](https://docs.docker.com/get-docker/)
+2. 检查端口`3000`是否被占用
+3. 在根目录打开命令行工具
+4. 运行以下命令启动项目
+```shell
+docker-compose -f docker-compose.yml up
+```
+
+### Ubuntu
+
+1. 安装 [Node.js](https://nodejs.org/en/download/)
+
+2. 安装依赖
+
+```bash
+npm install
+# or
+yarn install
+```
+3. 运行以下命令启动项目
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

__mocks__/fileMock.js

@@ -0,0 +1,3 @@
+// __mocks__/fileMock.js
+
+module.exports = 'test-file-stub';

__mocks__/styleMock.js

@@ -0,0 +1,3 @@
+// __mocks__/styleMock.js
+
+module.exports = {};

components/README.md

@@ -0,0 +1 @@
+# 组件

components/base/README.md

@@ -0,0 +1 @@
+# 组建-基础组件

components/base/Title/Title.js

@@ -0,0 +1,3 @@
+const Title = ({ label }) => <h1>{label}</h1>;
+
+export default Title;

components/base/Title/Title.spec.js

@@ -0,0 +1,12 @@
+import { mount } from 'enzyme';
+
+import Title from './title';
+
+/** @test {Title Component} */
+describe('Title Component', () => {
+    it('should render without crashing', () => {
+        const wrapper = mount(<Title label="test" />);
+
+        expect(wrapper.find('h1')).toHaveLength(1);
+    });
+});

components/common/README.md

@@ -0,0 +1 @@
+# 组建-公用组件

components/containers/README.md

@@ -0,0 +1 @@
+# 组建-容器组件

config/README.md

@@ -0,0 +1 @@
+# 配置文件

docker-compose.dev.yml

@@ -0,0 +1,13 @@
+version: '3.5'
+
+services:
+    bill_dev:
+        container_name: 'bill_dev'
+        ports:
+            - 3000:3000
+        build:
+            context: .
+            dockerfile: Dockerfile.dev
+        volumes:
+            - .:/app
+            - /app/node_modules

docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.5'
+
+services:
+    bill:
+        command: yarn start
+        container_name: 'bill'
+        ports:
+            - 3000:3000
+        build:
+            context: .
+            dockerfile: Dockerfile

jest.config.js

@@ -0,0 +1,35 @@
+module.exports = {
+    collectCoverageFrom: [
+        '**/*.{js,jsx}',
+        '!**/node_modules/**',
+        '!**/tests/**',
+        '!**/coverage/**',
+        '!jest.config.js'
+    ],
+    coverageThreshold: {
+        global: {
+            branches: 100,
+            functions: 100,
+            lines: 100,
+            statements: 100
+        }
+    },
+    moduleNameMapper: {
+        '\\.(css|less|scss)$': '<rootDir>/__mocks__/styleMock.js',
+        '\\.(jpg|jpeg|png|gif|eot|otf|webp|svg|ttf|woff|woff2|mp4|webm|wav|mp3|m4a|aac|oga)$':
+            '<rootDir>/__mocks__/fileMock.js',
+        '@/(.*)$': '<rootDir>/$1'
+    },
+    setupFiles: ['<rootDir>/tests/setup.js'],
+    setupFilesAfterEnv: ['<rootDir>/tests/setupAfterEnv.js'],
+    testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
+    testPathIgnorePatterns: [
+        '/.next/',
+        '/node_modules/',
+        '/tests/',
+        '/coverage/'
+    ],
+    transform: {
+        '^.+\\.jsx?$': 'babel-jest'
+    }
+};

package.json

@@ -0,0 +1,26 @@
+{
+  "name": "bill",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "next dev",
+    "build": "next build",
+    "start": "next start",
+    "test": "jest",
+    "test:coverage": "jest --coverage",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@babel/preset-env": "^7.11.5",
+    "@babel/preset-react": "^7.10.4",
+    "@reduxjs/toolkit": "^1.4.0",
+    "babel-jest": "^26.3.0",
+    "enzyme": "^3.11.0",
+    "enzyme-adapter-react-16": "^1.15.4",
+    "jest": "^26.4.2",
+    "next": "^9.5.3",
+    "react": "^16.13.1",
+    "react-dom": "^16.13.1",
+    "react-redux": "^7.2.1"
+  }
+}

pages/_app.js

@@ -0,0 +1,13 @@
+import '../styles/globals.css';
+import { Provider } from 'react-redux';
+import store from '../store';
+
+function MyApp({ Component, pageProps }) {
+    return (
+        <Provider store={store}>
+            <Component {...pageProps} />
+        </Provider>
+    );
+}
+
+export default MyApp;

pages/api/hello.js

@@ -0,0 +1,6 @@
+// Next.js API route support: https://nextjs.org/docs/api-routes/introduction
+
+export default (req, res) => {
+  res.statusCode = 200
+  res.json({ name: 'John Doe' })
+}

pages/index.js

@@ -0,0 +1,65 @@
+import Head from 'next/head'
+import styles from '../styles/Home.module.css'
+
+export default function Home() {
+  return (
+    <div className={styles.container}>
+      <Head>
+        <title>Create Next App</title>
+        <link rel="icon" href="/favicon.ico" />
+      </Head>
+
+      <main className={styles.main}>
+        <h1 className={styles.title}>
+          Welcome to <a href="https://nextjs.org">Next.js!</a>
+        </h1>
+
+        <p className={styles.description}>
+          Get started by editing{' '}
+          <code className={styles.code}>pages/index.js</code>
+        </p>
+
+        <div className={styles.grid}>
+          <a href="https://nextjs.org/docs" className={styles.card}>
+            <h3>Documentation &rarr;</h3>
+            <p>Find in-depth information about Next.js features and API.</p>
+          </a>
+
+          <a href="https://nextjs.org/learn" className={styles.card}>
+            <h3>Learn &rarr;</h3>
+            <p>Learn about Next.js in an interactive course with quizzes!</p>
+          </a>
+
+          <a
+            href="https://github.com/vercel/next.js/tree/master/examples"
+            className={styles.card}
+          >
+            <h3>Examples &rarr;</h3>
+            <p>Discover and deploy boilerplate example Next.js projects.</p>
+          </a>
+
+          <a
+            href="https://vercel.com/import?filter=next.js&utm_source=create-next-app&utm_medium=default-template&utm_campaign=create-next-app"
+            className={styles.card}
+          >
+            <h3>Deploy &rarr;</h3>
+            <p>
+              Instantly deploy your Next.js site to a public URL with Vercel.
+            </p>
+          </a>
+        </div>
+      </main>
+
+      <footer className={styles.footer}>
+        <a
+          href="https://vercel.com?utm_source=create-next-app&utm_medium=default-template&utm_campaign=create-next-app"
+          target="_blank"
+          rel="noopener noreferrer"
+        >
+          Powered by{' '}
+          <img src="/vercel.svg" alt="Vercel Logo" className={styles.logo} />
+        </a>
+      </footer>
+    </div>
+  )
+}

prettier.config.js

@@ -0,0 +1,36 @@
+// prettier.config.js or .prettierrc.js
+module.exports = {
+    // 一行最多 100 字符
+    printWidth: 100,
+    // 使用 4 个空格缩进
+    tabWidth: 4,
+    // 不使用缩进符，而使用空格
+    useTabs: false,
+    // 行尾需要有分号
+    semi: true,
+    // 使用单引号
+    singleQuote: true,
+    // jsx 不使用单引号，而使用双引号
+    jsxSingleQuote: false,
+    // 末尾不需要逗号
+    trailingComma: 'none',
+    // 大括号内的首尾需要空格
+    bracketSpacing: true,
+    // jsx 标签的反尖括号需要换行
+    jsxBracketSameLine: false,
+    // 箭头函数，只有一个参数的时候，也需要括号
+    arrowParens: 'always',
+    // 每个文件格式化的范围是文件的全部内容
+    rangeStart: 0,
+    rangeEnd: Infinity,
+    // 不需要写文件开头的 @prettier
+    requirePragma: false,
+    // 不需要自动在文件开头插入 @prettier
+    insertPragma: false,
+    // 使用默认的折行标准
+    proseWrap: 'preserve',
+    // 根据显示样式决定 html 要不要折行
+    htmlWhitespaceSensitivity: 'css',
+    // 换行符使用 lf
+    endOfLine: 'lf'
+};

public/README.md

@@ -0,0 +1,8 @@
+# 静态资源目录
+
+Next.js 默认以`public`为静态资源目录：
+
+* https://nextjs.org/learn/basics/assets-metadata-css/assets
+
+> Next.js can serve static files, like images, under the top-level public directory. Files inside public can be referenced from the root of the application similar to pages.
+

store/index.js

@@ -0,0 +1,6 @@
+import { configureStore } from '@reduxjs/toolkit';
+
+export default configureStore({
+    reducer: {
+    }
+});