开源项目 Wisp 使用教程

开源项目 Wisp 使用教程

wisp🧚 A practical web framework for Gleam项目地址:https://gitcode.com/gh_mirrors/wisp3/wisp

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

wisp/
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── main/
│   │   ├── App.js
│   │   └── index.js
│   └── utils/
│       └── helper.js
├── config/
│   ├── default.json
│   └── production.json
├── tests/
│   └── App.test.js
├── .gitignore
├── package.json
└── README.md

• docs/: 包含项目的文档文件，如 README.md 和 CONTRIBUTING.md。
• src/: 项目的源代码目录，包含主应用程序文件和工具函数。
  • main/: 主应用程序文件，如 App.js 和 index.js。
  • utils/: 包含辅助函数文件，如 helper.js。
• config/: 配置文件目录，包含默认配置和生产环境配置。
• tests/: 测试文件目录，包含应用程序的测试文件。
• .gitignore: Git 忽略文件。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目的主要说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/main/index.js。该文件主要负责启动应用程序，并初始化必要的配置和服务。

// src/main/index.js
const express = require('express');
const app = express();
const config = require('../config/default.json');

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(config.port, () => {
  console.log(`App listening on port ${config.port}`);
});

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，包含 default.json 和 production.json 两个文件。

• default.json: 默认配置文件，包含开发环境的配置。

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "dev_db"
  }
}

• production.json: 生产环境配置文件，包含生产环境的配置。

{
  "port": 8080,
  "database": {
    "host": "prod.example.com",
    "port": 5432,
    "name": "prod_db"
  }
}

这些配置文件通过环境变量加载，确保应用程序在不同环境下运行时使用正确的配置。

wisp🧚 A practical web framework for Gleam项目地址:https://gitcode.com/gh_mirrors/wisp3/wisp