# my-egg-project

**Repository Path**: peerlessXu/my-egg-project

## Basic Information

- **Project Name**: my-egg-project
- **Description**: 基于egg+vue+element编写的网站。

- **Primary Language**: JavaScript
- **License**: MulanPSL-1.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 4
- **Forks**: 2
- **Created**: 2020-12-14
- **Last Updated**: 2022-05-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# eggProject

## 介绍
基于eggjs+vue+elementUI+vant编写的网站。后台端增删改查商品，移动端完成展示购买流程。

## 软件架构
软件架构说明

##### 技术栈
- 服务端：nodejs，koa2，框架eggjs
- 前端：vuejs，框架elementUI，vant
- 数据库：mysql
- 其他：JWT，sequelize，redis等

##### 已完成功能
- 用户登录注册
- jwt登录权限验证
- 图片单张及多张上传
- 全局错误捕获及处理
- 商品的增删改查
- 移动端通过随机数模拟短信验证码，通过redis存储校验

##### 演示地址
目前暂未上线，后期更新线上

#### 安装使用教程

1.  安装node，mysql。
2.  mysql创建egg_test数据库
`CREATE DATABASE IF NOT EXISTS egg_test DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;`
3.  克隆项目到本地 `git clone git@gitee.com:peerlessXu/my-egg-project.git`。(后台管理端代码在admin文件夹，后端接口服务代码在eggjs文件夹，移动端代码在shop文件夹)
4. 分别进入admin、eggjs和shop目录下执行`npm i`。
4. 修改/eggjs/config/config.default.js文件中的config.sequelize字段为你本地mysql数据库的信息；同时修改该文件的config.redis字段为你本地redis的信息。
6. 运行项目
    - 方法一、如果使用的是vscode编辑器，进入调试栏目，选择启动`vue-admin`、`vue-shop`和`Egg Dev`即可。
    - 方法二、进入eggjs目录,执行`npm run start`启动后端服务，执行`npm run apidoc`生成接口文档；进入admin目录，执行`npm run start`启动前端服务。
    - 运行后地址：http://localhost:8080/（后台前端）；http://localhost:8082/（移动端前端）；http://localhost:7001/（接口服务）；http://localhost:7001/public/api/index.html（接口文档地址）
    
#### 生产环境部署（后端接口服务）
1. 服务器node和mysql环境准备好。
2. 压缩eggjs文件夹后复制到服务器，然后解压到一个位置(位置随意)。
3. 进入文件夹根目录，执行`npm i`安装依赖。
4. 启动服务，执行`npm start`。（服务自动开启线程，所以启动后可以关闭命令窗口）。
5. 如要关闭服务，执行`npm run stop`。

#### 常见问题
- 运行时报错
    检查下mysql和redis是否正常运行