📰
imarket校园集市
  • Welcome
  • Introduce(简介)
  • Getting Started
    • Quickstart(快速开始)
  • API
    • 安全认证
    • Auth(认证与授权)
    • Account(账户管理)
    • Admin(管理员功能)
    • Post(帖子管理)
    • User(用户相关)
    • Comments(评论管理)
    • Message(站内消息)
    • Image(图片管理)
    • Search(搜索功能)
  • Plugin
    • Introduce(插件系统简介)
    • Start(快速上手)
    • Dependency Injection(依赖注入)
    • API (状态接口)
  • Database
    • Tables(数据库表结构)
    • create_tables_script(数据库创建脚本)
Powered by GitBook
On this page
  • 1. 创建数据库
  • 2. 下载项目
  • 3. 配置项目
  • 4. 运行项目
  • 5. 测试接口
  1. Getting Started

Quickstart(快速开始)

快速上手

PreviousIntroduce(简介)Next安全认证

Last updated 3 months ago

1. 创建数据库

  1. 确保已安装 MySQL 数据库,并运行以下命令以创建项目所需的数据库。

    连接数据库

    mysql -u root -p

  2. 创建数据库和用户,your_password换成你想要的密码

    CREATE DATABASE imarket;
    CREATE USER 'imarket_root'@'localhost' IDENTIFIED BY 'your_password';
    GRANT ALL PRIVILEGES ON imarket.* TO 'imarket_root'@'localhost';
    FLUSH PRIVILEGES;

如果是在window上面可以用docker容器来实现

2. 下载项目

  1. (推荐)下载release版本

  2. 或者克隆代码仓库

git clone git@github.com:jeanhua/imarket-backend.git

3. 配置项目

  1. 修改配置文件: 编辑 appsettings.json,填写数据库连接字符串,your_password换成你上面设置的密码

    {
        "ConnectionStrings": {
            "DefaultConnection": "Server=localhost;Database=imarket;User Id=imarket_root;Password=your_password;"
        }
    }

  2. 填写密钥和token有效时间 ( 默认60分钟 ),refresh token有效时间(默认为7天)

    "JwtSettings": {
      "Key": "your password here, must be more than 32 bytes",
      "Issuer": "imarket",
      "Audience": "web-client",
      "ExpiresInMinutes": 60,
      "RefreshTokenExpiresInDays" : 7
    }

  3. 填写超级管理员信息

    "admin":{
        "Username":"admin",
        "Email":"admin@imarkt.com",
        "Password":"your password"
      }
  4. 填写缓存时间(秒),0为不缓存

    缓存有助于减少数据库访问次数,节省服务器性能

    "Cache":{
        "Posts":30,
        "SinglePost":180
      }

缓存时间过长会导致帖子页面刷新不及时

配置邮件功能(可选)

"MailSetting":{
    "Enable":false,
    "Name":"iMarket",
    "EmailAddress":"your email address",
    "EmailPassword":"your-email-password",
    "HtmlEnable":false,
    "SmtpHost":"smtp.example.com",
    "SmtpPort":587,
    "SslEnable":true
  }

4. 运行项目

如果是release版,直接运行imarket即可,支持参数 --port=指定端口

如果是克隆的代码,进行如下操作

  1. 安装依赖:

    dotnet restore
  2. 运行项目:

    dotnet run
  • 后端 API 默认运行在 https://localhost:5001

5. 测试接口

  1. 使用 Postman 或其他 API 测试工具导入项目的 API 文档(例如:Swagger 文件)。

  2. 根据 API 文档测试后端接口功能,例如用户注册、登录、发帖、评论等。

Docker安装并使用Mysql(可用详细)_docker安装mysql-CSDN博客
Logo