Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rolling-scopes/rsschool-app

An application for the RS School education process
https://github.com/rolling-scopes/rsschool-app

hacktoberfest

Last synced: 2 days ago
JSON representation

An application for the RS School education process

Awesome Lists containing this project

README

        

[![Deploy](https://github.com/rolling-scopes/rsschool-app/actions/workflows/deploy.yaml/badge.svg?branch=master)](https://github.com/rolling-scopes/rsschool-app/actions/workflows/deploy.yaml)

# RS School App

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

## Monitoring

https://status.rs.school/

## Technology Overview

### Stack

- Language: [Typescript](https://www.typescriptlang.org/)
- Front-end: [Next.js](https://nextjs.org/) / [React](https://reactjs.org/)
- Back-end: [NestJS](https://nestjs.com/) and [Koa.js](https://koajs.com/) (deprecated backend) / [Node.js](https://nodejs.org/en/)
- End-to-end: [Playwright](https://playwright.dev/)
- Database: [PostgreSQL](https://www.postgresql.org/)
- Deployment: [Podman](https://podman.io/)

### Infrastructure

- Cloud: [AWS EC2](https://aws.amazon.com/ec2/), [AWS RDS](https://aws.amazon.com/rds/postgresql/), [AWS S3](https://aws.amazon.com/s3/), [AWS CloudWatch](https://aws.amazon.com/cloudwatch/)
- Monitoring: [Sentry](https://rs-school.sentry.io/), [Checkly](https://app.checklyhq.com/)
- CI/CD: [Github Actions](https://github.com/rolling-scopes/rsschool-app/tree/master/.github/workflows)

## Getting Started

### Prerequisites

Please install the following software before starting development:

- [Git 2.10+](https://git-scm.com/downloads)
- [Node.js LTS](https://nodejs.org/en/download/)
- [Podman](https://podman.io/docs/installation)
- [podman-compose](https://github.com/containers/podman-compose)

### Steps

- Clone [repository](https://github.com/rolling-scopes/rsschool-app)
- 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](https://github.com/rolling-scopes/rsschool-app/blob/master/CONTRIBUTING.md) guide

### Running docs locally

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

## Contributing

See [CONTRIBUTING](https://github.com/rolling-scopes/rsschool-app/blob/master/CONTRIBUTING.md) guide

## Contributors

### Code Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



_Made with [contrib.rocks](https://contrib.rocks)_

### Financial Contributors

Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/rsschool/contribute)]

#### Individuals

#### Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/rsschool/contribute)]


## License

[Mozilla Public License 2.0](https://github.com/rolling-scopes/rsschool-app/blob/master/LICENSE)