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)

nestjs
Searching Database…

What is this?This is the web application that powers the RS School educational program, helping thousands of students become front-end, back-end, mobile, and data science engineers.
Is this a single app or multiple services?It's a monorepo split into three workspaces: a Next.js/React client, a NestJS back-end, and a legacy Koa.js server, managed together with Turbo.
How do I run it locally for development?Clone the repo, run npm install, start the local database with npm run db:up, restore a test snapshot with npm run db:restore, set up .env files from the examples, then run npm start to launch Next.js and the REST API together.
What do I need installed before I start?You need Git 2.10+, a current Node.js LTS release, and Podman with podman-compose to run the local database container.
Is the old server backend still maintained?No, the Koa.js server workspace is explicitly marked deprecated in favor of the newer NestJS back-end.
Who actually uses this app?It's used by RS School students and mentors across front-end, back-end, mobile, and data science tracks, plus course staff who manage the educational process through it.
Where does this run in production?The production deployment runs on AWS infrastructure (EC2, RDS, S3, CloudWatch) with Sentry and Checkly for monitoring, deployed via GitHub Actions.
Can I preview the documentation site locally?Yes, install docsify-cli globally and run docsify serve -p 4000 docs to view the docs folder in a browser.
Does the project use end-to-end testing?Yes, it uses Playwright for end-to-end tests, run via the Turbo-managed test scripts.
What database does it use?PostgreSQL, accessed through TypeORM, and managed locally via a Podman-based database container.
Size
35.5 MB
Stars
10.4K
Updated
CommitOct 04
Age
8y
Commits · 90 Days