rsschool-app README

The project's README from github.com/rolling-scopes/rsschool-app. As one markdown file: README.md.

Deploy

RS School App

app.rs.school is an application for the RS School educational process. It helps thousands of students become front-end, back-end, mobile, and data science engineers.

Monitoring

https://status.rs.school/

Technology Overview

Stack

Infrastructure

Getting Started

Repository is organized into 3 workspaces: server, nestjs, client. Each workspace has its own package.json and npm scripts. We use Turbo to run scripts across workspaces.

Prerequisites

Please install the following software before starting development:

Steps

Running docs locally

Contributing

See CONTRIBUTING guide

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Made with contrib.rocks

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

Mozilla Public License 2.0

rsschool-app (rolling-scopes/rsschool-app)

Searching Database…

这是什么?这是为 RS School 教育项目提供支持的 Web 应用,帮助成千上万的学生成长为前端、后端、移动端和数据科学工程师。
这是单一应用还是多个服务?它是一个 monorepo,分为三个工作区:一个 Next.js/React 客户端、一个 NestJS 后端,以及一个旧版 Koa.js 服务器,由 Turbo 统一管理。
我怎么在本地运行它进行开发?克隆仓库,运行 npm install,用 npm run db:up 启动本地数据库,用 npm run db:restore 恢复测试快照,根据示例文件设置 .env 文件,然后运行 npm start 同时启动 Next.js 和 REST API。
开始之前我需要安装什么?你需要 Git 2.10+、当前的 Node.js LTS 版本,以及带有 podman-compose 的 Podman,用于运行本地数据库容器。
旧的服务端后端还在维护吗?不再维护。Koa.js 服务器工作区已明确标记为弃用,由更新的 NestJS 后端取代。
到底谁在使用这个应用?它的用户包括 RS School 的学生和导师,涵盖前端、后端、移动端和数据科学方向,还有通过它管理教学流程的课程工作人员。
这个应用在哪里正式运行?正式环境部署在 AWS 基础设施上(EC2、RDS、S3、CloudWatch),使用 Sentry 和 Checkly 进行监控,并通过 GitHub Actions 部署。
我能在本地预览文档站点吗?可以。全局安装 docsify-cli,然后运行 docsify serve -p 4000 docs,即可在浏览器中查看 docs 文件夹。
这个项目使用端到端测试吗?使用。它用 Playwright 进行端到端测试,通过 Turbo 管理的测试脚本运行。
它使用什么数据库?PostgreSQL,通过 TypeORM 访问,并通过基于 Podman 的数据库容器在本地管理。
Size
35.5 MB
Stars
10.4K
Updated
CommitOct 04
Age
8y
Commits · 90 Days