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. Оно помогает тысячам студентов стать инженерами фронтенда, бэкенда, мобильной разработки и анализа данных.
Это одно приложение или несколько сервисов?Это монорепозиторий, разделённый на три рабочих пространства: клиент на 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 с podman-compose для запуска контейнера с локальной базой данных.
Поддерживается ли до сих пор старый серверный бэкенд?Нет, рабочее пространство 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