README.md

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

• Language: TypeScript
• Front-end: Next.js / React
• Back-end: NestJS and Koa.js (deprecated backend) / Node.js
• End-to-end: Playwright
• Database: PostgreSQL
• Deployment: Podman

Infrastructure

• Cloud: AWS EC2, AWS RDS, AWS S3, AWS CloudWatch
• Monitoring: Sentry, Checkly
• CI/CD: GitHub Actions

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:

• Git 2.10+
• Node.js LTS
• Podman
• podman-compose

Steps

• Clone repository
• Run npm install (installs dependencies in the root folder and client / server folders.)
• Run npm run db:up (starts local database)
• Run npm run db:restore (restores a test DB snapshot)
• Make copies of server/.env.example and nestjs/.env.example, then rename them to server/.env and nestjs/.env respectively
• Run npm start (starts application by running Next.js and REST API server)
• Open http://localhost:3000 in a browser
• See more in CONTRIBUTING guide

Running docs locally

• Install docsify globally: npm i -g docsify-cli
• Run docsify serve -p 4000 docs

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