Skip to content

BinaryStudioAcademy/bsa-winter21-22-codi

Repository files navigation

BSA 2021-2022 | .NET | Codi

Codi is an educational platform that provides a platform for student-teacher cooperation including course management, homework assignments and innovative review process. Main goal of the project is to allow users to have a full-fledged educational experience with live coding sessions and review. The project is based on replit

Technologies:

Backend:

  • Platform: .NET 6
  • Network: REST, SignalR, RabbitMQ
  • Database: MS SQL Server, Entity Framework Core
  • Cloud: Azure
  • Other: JWT, Firebase, Elasticsearch, Kibana, Docker

Frontend:

  • Angular
  • Bootstrap
  • HTML5/CSS3/SASS

Links:

Building sources

By default, apps run on the following ports:

Application Port
Codi.Core 5050
Codi.Notifier 5070
Codi.Builder 5090
Codi.Frontend 80 or 4200
RabbitMQ 5672
Elasticsearch 9200
Kibana 5601
MongoDB 27017

Tip: If you want to connect to the specific service outside of docker, then use "localhost" as a service name, but if both services are inside docker, use service_name from a "docker-compose" file instead.

Code quality

Make sure you read and follow .NET Quality Criteria. Also, there are some best practices for frontend development: Angular and Typescript

Docker:

  1. Make sure you have Docker and Docker Compose.
  2. Pull this repo to your machine.
  3. You can build and run all application containers via docker-compose -f docker-compose.apps.yml up -d command.
  4. You can pull and run all 3rd-party services (MSSQL Server, ELK, RabbitMQ) via docker-compose -f docker-compose.services.yml up -d command.
  5. Happy coding! 😎

Setup environment for local development:

  1. Download and install .NET 6 SDK.
  2. It might be usefull to have EF CLI. Install via command: dotnet tool install --global dotnet-ef
  3. Download and install LTS version of Node.js
  4. Install Angular-CLI via: npm install -g @angular/cli. What is Angular-CLI?

Extensions for frontend development (required):

  • ESLint (analysis tool that checks TypeScript\JavaScript code for readability, maintainability, and functionality errors)
  • EditorConfig (helps maintain consistent coding styles for multiple developers working on the same project)

Some extra extensions which can significantly help to work with Angular:

  • Angular Language Service (intelliSense for Angular templates)
  • Angular Snippets
  • Angular Schematics (working with Angular schematics via UI)

Environment variables

This is a list of the required environment variables:

RabbitMQ

RABBIT_MQ_USERNAME - RabbitMQ username

RABBIT_MQ_PASSWORD - RabbitMQ user password

MSSQL Server

SA_PASSWORD - MSSQL Server "SA" user password

MongoDB

MONGO_USERNAME - MongoDB username

MONGO_PASSWORD - MongoDB user password