https://github.com/coder-hxl/coderhub-api

coderhub API —— 基于 NodeJS 和 MySQL 开发的社交平台接口, 采用 REST 设计风格, 主要使用 TypeScript 来开发。
https://github.com/coder-hxl/coderhub-api

api mysql nodejs typescript

Last synced: 3 months ago
JSON representation

coderhub API —— 基于 NodeJS 和 MySQL 开发的社交平台接口, 采用 REST 设计风格, 主要使用 TypeScript 来开发。

• Host: GitHub
• URL: https://github.com/coder-hxl/coderhub-api
• Owner: coder-hxl
• Created: 2022-07-13T09:22:43.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-11-23T01:46:34.000Z (over 2 years ago)
• Last Synced: 2025-02-15T05:17:03.132Z (4 months ago)
• Topics: api, mysql, nodejs, typescript
• Language: TypeScript
• Homepage:
• Size: 8.32 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# coderhub API

**coderhub API** —— 基于 **NodeJS** 和 **MySQL** 开发的社交平台接口, 采用 **REST** 设计风格, 主要使用 **TypeScript** 来开发。

## 使用

**项目环境:** 

* NodeJS

* MySQL

**接口设计风格:**

* REST

**进入 coderhub 文件后执行如下操作:**

1. 安装 pnpm

```shell

npm install pnpm -g

```

2. 安装依赖

```shell

pnpm install

```

3. 启动服务

```shell

pnpm start

```

4. 运行SQL文件

创建 coderhub 数据库, 运行 coderhub数据库.sql  文件。

5. 配置 .env 文件

在此文件填写你电脑上的 MySQL 配置信息...

**获取数据**

默认在 http://localhost:8888 启动服务。

例如:

获取全部动态

```HTTP

GET /moments

```

获取某一条动态

```HTTP

GET /moments/:momentId

```

详情请看 src/router 里面的文件。