Name: Anthony Del Rosario

Email: adelrosarioh@gmail.com

1. Installation instructions
2. How to Use
   • Management Tools
   • Shutting down app
3. Technologies used
   • Back-End
   • Front-End
   • Libraries
4. Project Architecture
   • Overview
   • Web API - RESTful Endpoints
   • Web API - WebSockets Endpoints
5. Requirements
6. Requirements
7. Development
   • Runtime and SDKs
   • Dependencies
   • Front-End - WebApp
   • Back-End - WebAPI
   • Back-End - StocksBot

• Download zip or clone this repository using git
• Install Docker (you can download docker from here)
• Open repository folder into terminal
• Execute the following command docker-compose up -d to start the services in detached mode
• or execute docker-compose up to see the logs

The installation process should take about 15 minutes depending on your internet connection and computer specs.

Click here to go into the webapp. You can register a new account in here or login here if you already have one.

You can have multiple user sessions login in from a different browser window (not browser tab).

Make sure you are using one of the following supported browsers:

• Chrome latest
• Firefox latest and extended support release (ESR)
• Edge 2 most recent major versions
• IE 11

To connect to MSSQL Server 2017 using SQL Management Studio or other tool use the following connection parameters:

• Server: localhost,1433
• User: SA
• Password: P455w0rd123456789

To connect to RabbitMQ Management go to http://localhost:15672/ in your browser and login with the following credentials:

• Username: guest
• Password: guest

You can shutdown all services at once executing docker-compose down in your terminal.

• .NET Core 3.1
• ASP.NET Core 3.1
• RabbitMQ
• MSSQL Server 2017
• NGINX
• Docker

• Angular 10

• Bootstrap 4
• MomentJS
• ASP.NET Core SignalR
• RabbitMQ .NET Client
• Entity Framework Core
• TinyCsvParser

The project is separated in three application binaries. The FrontEnd web application developed using the Angular Framework, The BackEnd ASP.NET Core RESTful API Web API and a .NET Core Console application.

The BackEnd solution structure is divided into the following projects:

• Core: defines business entities and interfaces.
• Infrastructure: implements service interfaces and handles data storage and message queuing.
• ASP.NET Core WebAPI: fulfil frontend requests like, login, register and chat, also keeps listening for incoming stock share price responses from the queue.
• StockBot Console app: keeps listening for incoming stock share price requests from queue, requests stock share price from http://stooq.com and pushes a message into the stock share price response queue with the parsed data.

The WebAPI has RESTful endpoints for account authentication, account registration and getting the last messages and implements WebSocket endpoints to handle real-time chat features using ASP.NET Core SignalR.

The FrontEnd web application is dockerized and served by NGINX which is also used as a reverse proxy, forwarding requests to the Web API.

• Allow registered users to log in and talk with other users in a chatroom.

  • Users can register a new account and log in into the chatroom.

• Allow users to post messages as commands into the chatroom with the following format /stock=stock_code

  • the /stock command is handled asynchronously, if the app doesn't understand the command a message is displayed.

• Create a decoupled bot that will call an API using the stock_code as a parameter (https://stooq.com/q/l/?s=aapl.us&f=sd2t2ohlcv&h&e=csv, here aapl.us is the stock_code)

• The bot should parse the received CSV file and then it should send a message back into the chatroom using a message broker like RabbitMQ. The message will be a stock quote using the following format: “APPL.US quote is $93.42 per share”. The post owner will be the bot.

  • A decoupled NET Core app is consuming from the request queue, calling the stooq web service, parsing CSV response and then pushing that stock information into the queue for any client consumer to do something with it.

• Have the chat messages ordered by their timestamps and show only the last 50 messages.

  • After login and page is refreshed the chatroom displays the last 50 messages ordered by their timestamps.

• Unit test the functionality you prefer.

  • Unit Tests were done using NUnit and Moq. Tests are located in the BackEnd/JobsityStocksChat/JobsityStocksChat.UnitTests project.

• Use .NET identity for users authentication

  • User register and login provided by .NET Core Identity.

• Handle messages that are not understood or any exceptions raised within the bot.

  • If the bot didn't find a stock by its stock code it would say "I'm sorry, I couldn't find the stock you asked for.".

• Build an installer.

  • The use of 'docker-compose` keeps the application setup simple and as closed to deploying the application to a production environment as possible.

• Download and install Docker (https://docs.docker.com/get-docker/)
• Download and install .NET Core 3.1 SDK (https://dotnet.microsoft.com/download)
• Download and install NodeJS (https://nodejs.org/en/download/)

• Start MSSQL Server 2017 docker container:

   docker run -d --hostname mssqldb --name mssqldb_dev -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=P455w0rd123456789" -p 1433:1433 mcr.microsoft.com/mssql/server:2017-CU21-ubuntu-16.04
  

• Start RabbitMQ docker container:

   docker run -d --hostname rabbitmq --name rabbitmq_dev -p 5672:5672 -p 15672:15672 rabbitmq:3-management
  

• Open this repository folder in the terminal and change directory to FrontEnd/JobsityStocksChat

• Install project dependencies by running command:

   npm install
  

• Start development server by running command:

   ng serve
  

• Go to http://localhost:4200/

• Open this repository folder in the terminal and change directory to BackEnd/JobsityStocksChat/JobsityStocksChat.WebAPI

• Install project dependencies by running command:

   dotnet restore "JobsityStocksChat.WebAPI.csproj"
  

• Start project by running command:

   dotnet run --launch-profile "JobsityStocksChat.WebAPI"
  

• Web API server is running on http://localhost:5000

• Open this repository folder in the terminal and change directory to BackEnd/JobsityStocksChat/JobsityStocksChat.StocksBot

• Install project dependencies by running command:

   dotnet restore "JobsityStocksChat.StocksBot.csproj"
  

• Start project by running command:

   dotnet run --launch-profile "JobsityStocksChat.StocksBot"