RS School App

The app.rs.school is an application for the RS School education process. It helps thousands students to become Front-end/Back-end/Mobile/Data Science engineers.

Monitoring

https://status.app.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: Docker

Infrastructure

• Cloud: AWS EC2, AWS RDS, AWS S3, AWS CloudWatch
• CI/CD: Github Actions

Getting Started

Prerequisites

Please install the following software before starting development:

• Git 2.10+
• Node.js LTS
• Docker
• Docker 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 (restore a test DB snapshot)
• Make a copy of server/.env.example and nestjs/.env.example and rename it to server/.env and nestjs/.env respectively.
• Run npm start (starts application by running Next.js and REST API server)
• Open https://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