https://github.com/huayemao/cheertimetable-web
yet another curriculum query tool for CSUers
https://github.com/huayemao/cheertimetable-web
css-doodle csu education nextjs react reactjs tailwind tailwindcss vercel
Last synced: about 20 hours ago
JSON representation
yet another curriculum query tool for CSUers
- Host: GitHub
- URL: https://github.com/huayemao/cheertimetable-web
- Owner: huayemao
- Created: 2022-02-11T17:54:06.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-09-10T13:15:59.000Z (10 months ago)
- Last Synced: 2025-09-10T16:52:23.006Z (10 months ago)
- Topics: css-doodle, csu, education, nextjs, react, reactjs, tailwind, tailwindcss, vercel
- Language: TypeScript
- Homepage: https://qike.huayemao.run/
- Size: 2.1 MB
- Stars: 33
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Overview
见 [绮课简介](https://www.yuque.com/huayemao/cheer-timetable/overview)
## 技术栈
- [React.js](https://beta.reactjs.org/)
- [Next.js](https://nextjs.org/)
- [TailwindCss](https://tailwindcss.com/)
- [Prisma](https://www.prisma.io/)
## get Started
此文档可能并不足够详尽，如遇到问题，请联系作者
### prerequisite
0. 你心爱的命令行终端和代码编辑器
1. 安装 Node.JS 运行环境: [Node.js 12.22.0](https://nodejs.org/) 或更高版本；
2. 安装 yarn
3. 安装 MySQL 8.0
### 1. 克隆代码仓库
`git clone https://github.com/huayemao/cheerTimetable-web.git` 或 `git clone git@github.com:huayemao/cheerTimetable-web.git`
### 2. 配置环境变量
1. 数据库：准备一个 mysql 数据库实例，~~或者使用 [PlanetScale ](https://planetscale.com/)提供的服务，这也是目前绮课在生产环境所使用的。~~
2. 获取教务系统 jwctest 环境以 kbuser 课表数据查询用户登录后获得的 cookie，详见 [绮课如何从教务系统抓取数据 | Dors.——花野猫的数字花园](https://dors.huayemao.run/posts/81)
3. 在项目根目录创建环境变量文件 .env，使用 MySQL 数据库连接字符串和获得的 COOKIE 填写以下环境变量
```latex
DATABASE_URL='mysql://root:huayemao123@localhost:3306/cheerTimetable'
COOKIE='JSESSION_ID=XXX'
```
### 3. 安装依赖
使用 `npm install`或 `yarn`命令安装 npm 依赖
### 4. 导入数据
1. 运行 `yarn db:generate`
2. 运行 `yarn db:seed` ，自动从教务系统导入数据
### 5. 开发调试
运行 `yarn dev`将以开发模式启动 Next.js 项目，更多请见 [Next.js 文档](https://nextjs.org/docs/getting-started)
## 主要目录结构
```latex
├── _data // 以异步 IIFE 导出从教务系统获取数据所需的 JSON
├── components // React 组件
├── constants // 常量
├── contexts // 存放 React Contexts
├── lib // 抽出的工具函数
├── pages // Next.js 路由页面
├── prisma // 数据库相关，包括模式定义和数据库导入脚本
```