Strawberry 开源项目使用教程

Strawberry 开源项目使用教程

strawberryZero-dependency, build-free framework for the artisanal web.项目地址:https://gitcode.com/gh_mirrors/stra/strawberry

1. 项目的目录结构及介绍

strawberry/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── api.js
│   ├── models/
│   │   ├── user.js
│   ├── controllers/
│   │   ├── userController.js
│   ├── utils/
│   │   ├── helper.js
├── public/
│   ├── index.html
│   ├── css/
│   │   ├── style.css
│   ├── js/
│   │   ├── script.js

目录结构说明

• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • api.js: API 路由文件。
  • models/: 数据模型文件目录。
    • user.js: 用户模型文件。
  • controllers/: 控制器文件目录。
    • userController.js: 用户控制器文件。
  • utils/: 工具函数文件目录。
    • helper.js: 辅助函数文件。
• public/: 静态资源目录。
  • index.html: 主页文件。
  • css/: CSS 样式文件目录。
    • style.css: 主样式文件。
  • js/: JavaScript 脚本文件目录。
    • script.js: 主脚本文件。

2. 项目的启动文件介绍

index.js

const express = require('express');
const app = express();
const config = require('./config/default.json');

app.use(express.json());
app.use('/api', require('./routes/api'));

const PORT = process.env.PORT || config.port;

app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

启动文件说明

• 引入 express 模块并创建应用实例。
• 加载配置文件 default.json。
• 使用中间件解析 JSON 请求体。
• 挂载 API 路由。
• 监听指定端口启动服务器。

3. 项目的配置文件介绍

config/default.json

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "database": "strawberry"
  }
}

config/production.json

{
  "port": 8080,
  "database": {
    "host": "production_host",
    "user": "prod_user",
    "password": "prod_password",
    "database": "strawberry_prod"
  }
}

配置文件说明

• default.json: 默认配置文件，包含开发环境的端口和数据库配置。
• production.json: 生产环境配置文件，包含生产环境的端口和数据库配置。

以上是 Strawberry 开源项目的目录结构、启动文件和配置文件的详细介绍。希望这份教程能帮助你更好地理解和使用该项目。

strawberryZero-dependency, build-free framework for the artisanal web.项目地址:https://gitcode.com/gh_mirrors/stra/strawberry