# source-web

**Repository Path**: observerw/source-web

## Basic Information

- **Project Name**: source-web
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-01-21
- **Last Updated**: 2022-03-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 启动

```bash
# 先安装依赖
yarn install
# or
npm install
```

```bash
npm run dev
# or
yarn dev
```

然后在[http://localhost:3000](http://localhost:3000)中能够看到了。

# 目录结构

* pages 

    页面结构，在next.js中，每一个在pages中的文件都会被当作一个页面，该页面的路由即为该文件的名字；

    * api文件夹比较特殊，用于[Mock](https://juejin.cn/post/6850418109540073480)，写接口的时候可以在这里面写Mock数据用于测试。

* api

    所有的接口定义。

    * 每一个页面在api中有一个对应的文件夹，文件夹中的内容为相应请求的对应请求函数，以及该请求返回值对应的类型（在types.d.ts中定义）。

* components

    页面组件；

* stores

    redux数据中心；

* utils

    所有的工具类；

* styles

    CSS文件；

* public

    静态资源。

# 配置文件

* `.env.production`，`.env.development`：环境变量，在以dev模式运行时，next.js自动加载`.env.development`；而在build时自动加载`.env.production`；
* tailwind.config.js：`tailwindcss`配置文件；
* next.config.js：`next.js`配置文件；

# 备注

* 在文件中import内容时，前面不需要加`/`，默认为以根目录为基础的相对路径：

    ```js
    import styles from 'styles/Home.module.css' // source-web/styles/Homes.module.css
    ```

# 文档
- [Next.js Documentation](https://nextjs.org/docs) - Next.js文档；
- [Learn Next.js](https://nextjs.org/learn) - next.js教程。