Skip to content
/ MSE_StocksMarketAPI Public

The aim of this project is to develop a StockMarket Web API application in accordance with enterprise software development processes, clean code writing principles and best practices.

3 stars 0 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

bahadraksakal/MSE_StocksMarketAPI

BranchesTags

Repository files navigation

Mert Software - Long Term Imep Internship - StockMarket Web API Application

Mert Yazlım - Uzun Dönem Imep Staj - StockMarket Web API Uygulaması_1 Mert Yazlım - Uzun Dönem Imep Staj - StockMarket Web API Uygulaması_2 Mert Yazlım - Uzun Dönem Imep Staj - StockMarket Web API Uygulaması_3

[EN]

Problem Definition

Our project goal is to create a Web API service of a platform where stock portfolios are managed by the user in the admin role and registered users can perform purchase and sale transactions. It is not required to create an interface for the project. It is enough to create a collection on Postman and organize the requests in the required folder structure. Add test scripts to Postman requests according to "HTTP Status Code" returns. The stock information in the project should be updated regularly via a live Web API. The service that updates the stock information should be designed as a separate consol application and run once a minute by the Background Job application. Background Job should run as a separate consol project.
📃 Click for Project Details

Project Aims and Objectives

The aim of this project is to develop a StockMarket Web API application in accordance with enterprise software development processes, clean code writing principles and best practices.

Project Features

  • The user with the admin role and the MainBoard that holds my main site information are created at startup.
  • Admin can create new users and assign admin or user role to the users he/she creates.
  • Users should be able to register to the system and should be assigned to the user role by default.
  • When a user with the user role is created, a portfolio is created by the system in which the stock information of the user will be kept.
  • There is a balance service that contains user and system balance information.
  • Stocks are initially created by the API from a different source. The number of stocks is initially set to 10,000 by default.
  • Stock prices are regularly updated from the source used and users are allowed to trade with the last price information of the stock.
  • Two digit value is used for decimal precision in stock pricing.
  • Stock price movements can be kept in a table and historical price change information can be queried.
  • Admin can end or start buying and selling transactions by stopping the activation of stocks.
  • Admin can define balance card codes and balance amount based on balance codes for users to buy and sell. Each balance card can be used only once.
  • Users can load balances by sending requests with these balance card codes.
  • Users can purchase shares for their own portfolios as long as their balance amounts and the number of shares in the system are sufficient.
  • Users can perform sales transactions as long as the number of shares in their portfolios is sufficient.
  • By default, a 5% commission is charged on purchase and sale transactions and entered into the system balance.
  • System and user balance amounts and number of stocks are updated according to the purchase and sale information.
  • Buying and selling transactions are kept in a table and the transactions of the user can be analyzed in date range.
  • Users can create rule sets by setting lower or upper amount limits on stocks. They can be notified by e-mail when the stock price is updated.
  • Users can print stock price and trading transactions as Excel files.
  • Users can print stock price and trading transactions as Pdf files.
  • At the end of each month, transaction summaries for that month can be sent to users in pdf and excel format.

Technology and Languages Used in Projects

  • Asp.Net Core 7 🧩
  • .Net 7 (Console) 🧩
  • C# 🧩
  • MSSQL 🧩
  • Postman (Test Script) 🧩
  • JavaScript 🧩

Packages Used in the Project

GetStockServiceApp

  • .NET 7 (Console)
  • Microsoft.AspNetCore.Authentication.JwtBearer | Version="7.0.13"
  • Microsoft.Extensions.Configuration | Version="7.0.0"
  • Microsoft.Extensions.Configuration.Json | Version="7.0.0.0"
  • Serilog | Version="3.0.1"
  • Serilog.Sinks.Console | Version="4.1.0"
  • Serilog.Sinks.File | Version="5.0.0"

HangFireApp

  • .NET 7 (Console)
  • Hangfire | Version="1.8.6"
  • Hangfire.SqlServer | Version="5.1.2"
  • Microsoft.Data.SqlClient Version="5.1.2"
  • Microsoft.Extensions.Configuration | Version="7.0.0"
  • Microsoft.EntityFrameworkCore" Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer" Version="7.0.13"
  • Microsoft SQL Server | Version="15.0.4153"
  • Serilog | Version="3.0.1"
  • Serilog.Sinks.Console | Version="4.1.0"
  • Serilog.Sinks.File | Version="5.0.0"

StocksMarketWebAPI

  • Asp.NET Core 7
  • AutoMapper.Extensions.Microsoft.DependencyInjection | Version="12.0.1"
  • Microsoft.AspNetCore.Authentication.JwtBearer | Version="7.0.13"
  • Microsoft.AspNetCore.OpenApi | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.Tools | Version="7.0.13"
  • Serilog.AspNetCore | Version="7.0.0"
  • Serilog.Sinks.MSSqlServer | Version="6.3.0"
  • Swashbuckle.AspNetCore | Version="6.5.0"

HangFireDbContextLibrary

  • Microsoft.EntityFrameworkCore | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.Tools | Version="7.0.13"

SharedServices

  • EPPlus | Version="7.0.0"
  • iTextSharp.LGPLv2.Core | Version="3.4.12"
  • Serilog.AspNetCore | Version="7.0.0"
  • Serilog.Sinks.Debug | Version="2.0.0"
  • Serilog.Sinks.File | Version="5.0.0.0"

StocksMarketDbContextLibrary

  • Microsoft.EntityFrameworkCore | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.Tools | Version="7.0.13"

StocksMarketEntitiesLibrary

  • Microsoft.EntityFrameworkCore | Version="7.0.13"

ModalsLibrary

  • None

Project Stand Up Steps, General Project Logic and Notes

General Working Logic of the Project

  • Solition contains 3 applications and libraries used by these applications. GetStockService, HangFireApp and StocksMarketWebAPI applications form the basic solition content.
  • StocksMarketWebAPI and HangFireApp are configured to stand up and run together.
  • HangFireApp runs the GetStockService application via its own method.
  • HangFireApp application finds the stocks whose price changes and sends an email to the users who own and follow these stocks.
  • At the end of each month, HangFireApp sends transaction summary reports to users in excel and pdf format.
  • In order to detect stocks whose prices change, a matching process is performed with a second database, thus distributing the system load.
  • GetStockService is defined as a dependency of HangFireApp, so the GetStockService application is automatically compiled as the Web API and HangFireApp are launched.
  • HangFireApp runs GetStockService once every 3 minutes.
  • HangFireApp runs stock tracking and email service 1 time in 3 minutes.
  • HangFireApp runs SendMailMonthlyReport job 1 time per month.
  • GetStockService will pull all stocks and send a request to StocksMarketWebAPI (security check with token)
  • StocksMarketWebAPI application will automatically process the shares received through the controller and save them to the database. (If there is no stock, it adds a new record, if there is a stock, it adds the last price to the system.)
  • You can get your trading history or price movements of the relevant stock as excel output via StockMarketWeb API.

Project Stand Up Steps

  1. Clone the project.

  2. Install the project's dependencies using NuGet Package Manager to install the required packages before running the project.

  3. To run the project as Default:
      a) Run the project.

  4. To run the project Manually:
      a) Run the StocksMarketWebAPI application.
      b) Then compile the GetStockService application.
      c) Run the HangFireApp application.

  5. HangFireApp runs GetStockService once per minute. GetStockService pulls all the stocks and sends this data to the Web API.

  6. The StocksMarketWebAPI application automatically processes the stocks it receives and saves them in the database (if the stock does not exist, it adds a new record; if it exists, it updates its last price).

Notes

  • If the PUT method of GetStockService throws an error even though the main part of the project works, update the BaseUrl value in the appconfig file. Example: "BaseUrl": "https://localhost:7261/api/Stock/SetStocks"

  • To test the project, import a Postman generated and exported collection file (compatible with Postman V2.1). Update Token and BaseUrl in Postman environmental variables (Env.) according to your test scenario to test the project.

  • Review the configuration files in all three projects for database issues and adjust the Connection String according to your environment if necessary.

  • Since there are three different projects in a solution, you may get errors while running add-migration, update-database etc. commands. To avoid these errors, you must specify the target project when running the command. Example: Update-Database -Project StocksMarketWebAPI, add-migration -Project StocksMarketWebAPI migrationName

  • If you get an error that there are two context objects, apply a typing method like add-migration -Context ContextName etc.

  • Some operations may require administrator authorization. Administrator account: { username: admin, password: admin }.

Click for Database Design 👈

Click for Images from the Program 👈

Mert Yazlım - Uzun Dönem Imep Staj - StockMarket Web API Uygulaması

[TR]

Problem Tanımı

Proje hedefimiz admin rolündeki kullanıcı tarafından hisse senedi portföylerinin yönetildiği kayıtlı kullanıcıların alım, satım işlemleri gerçekleştirebildiği bir platformun Web API servisini oluşturmak. Proje için bir arayüz oluşturulması istenmemektedir. Postman üzerinde bir collection oluşturarak istekleri gerekli klasör yapısında düzenlemeniz yeterlidir. Postman isteklerine “HTTP Status Code” dönüşlerine göre test scriptlerini ekleyiniz. Projedeki hisse senedi bilgileri canlı olarak bir Web API üzerinden düzenli olarak güncellensin. Hisse senedi bilgilerini güncelleyen servis ayrı bir consol uygulaması olarak tasarlansın ve Background Job uygulaması tarafından dakikada 1 kez çalıştırılsın. Background Job'lar ayrı bir consol projesi olarak çalışmalıdır.
📃 Proje Detayları İçin Tıkla

Proje Amacı ve Hedefleri

Bu projenin amacı, kurumsal yazılım geliştirme süreçleri, temiz kod yazma prensipleri ve best practices'e uygun bir StockMarket Web API uygulaması geliştirmektir.

Proje Özellikleri

  • Admin rolüne sahip kullanıcı ve Ana sitem bilgilerini tutan MainBoard başlangıçta oluşturulur.
  • Admin yeni kullanıcılar oluşturabilir ve oluşturduğu kullanıcılara admin veya user rolü atayabilir.
  • Kullanıcılar sisteme kayıt olabilmeli ve varsayılan olarak user rolüne atanmalıdır.
  • User rolüne sahip kullanıcı oluştuğunda kullanıcıya ait hisse senetleri bilgisinin tutulacağı bir portföy sistem tarafından oluşturulur.
  • Kullanıcı ve sistem bakiye bilgisini içeren bir bakiye servisi bulunur.
  • Hisse senetleri farklı bir kaynaktan alınarak API tarafından başlangıçta oluşturulur. Hisse senedi adet bilgisini başlangıçta varsayılan olarak 10,000 adet olarak ayarlanır.
  • Hisse senedi fiyatları düzenli olarak kullanılan kaynaktan güncellenir ve kullanıcılara hissenin son fiyat bilgisi ile işlem yaptırılır.
  • Hisse fiyatlandırmalarında ondalık hassasiyet için iki haneli değer kullanılır.
  • Hisse senedi fiyat hareketleri bir tabloda tutularak geçmişe yönelik fiyat değişim bilgisi sorgulanabilir.
  • Admin hisse senetlerinin aktifliğini durdurarak alım ve satım işlemlerini sonlandırabilir veya başlatabilir.
  • Admin kullanıcıların alım satım yapabilmesi için bakiye kart kodları ve bakiye kodlarına bağlı bakiye miktarı tanımlayabilir. Her bakiye kartı sadece bir kez kullanılabilir.
  • Kullanıcılar bu bakiye kart kodları ile istek atarak kendilerine bakiye yükleyebilir.
  • Kullanıcılar bakiye miktarları ve sistem tarafındaki hisse adetleri yeterli olduğu sürece kendi portföylerine hisse alımı gerçekleştirebilir.
  • Kullanıcılar portföylerindeki hisse senedi adeti yeterli olduğu sürece satış işlemi gerçekleştirebilir.
  • Alım ve satım işlemleri üzerinden varsayılan olarak %5 komisyon alınarak sistem bakiyesine işlenir.
  • Sistem ve kullanıcı bakiye miktarları ve hisse senedi adetleri alım satım bilgisine göre güncellenir.
  • Alım, satım hareketleri bir tabloda tutularak kullanıcıya ait hareketler tarih aralığında incelenebilir.
  • Kullanıcılar hisse senetlerinde alt veya üst miktar limiti belirleyerek kural setleri oluşturabilir. Hisse senedi fiyatı güncellendiğinde e-posta ile bilgilendirme alabilirler.
  • Kullanıcılar tarafından hisse senedi fiyat ve alım satım hareketleri Excel dosyası olarak çıktı alınabilir.
  • Kullanıcılar tarafından hisse senedi fiyat ve alım satım hareketleri Pdf dosyası olarak çıktı alınabilir.
  • Kullancılara her ay sonunda, o aya ait işlem özetleri pdf ve excel formatında gönderilebilir.

Projelerde Kullanılan Teknoloji Ve Diller

  • Asp.Net Core 7 🧩
  • .Net 7 (Console) 🧩
  • C# 🧩
  • MSSQL 🧩
  • Postman (Test Script) 🧩
  • JavaScript 🧩

Projede Kullanılan Paketler

GetStockServiceApp

  • .NET 7 (Console)
  • Microsoft.AspNetCore.Authentication.JwtBearer | Version="7.0.13"
  • Microsoft.Extensions.Configuration | Version="7.0.0"
  • Microsoft.Extensions.Configuration.Json | Version="7.0.0"
  • Serilog | Version="3.0.1"
  • Serilog.Sinks.Console | Version="4.1.0"
  • Serilog.Sinks.File | Version="5.0.0"

HangFireApp

  • .NET 7 (Console)
  • Hangfire | Version="1.8.6"
  • Hangfire.SqlServer | Version="5.1.2"
  • Microsoft.Data.SqlClient Version="5.1.2"
  • Microsoft.Extensions.Configuration | Version="7.0.0"
  • Microsoft.EntityFrameworkCore" Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer" Version="7.0.13"
  • Microsoft SQL Server | Version="15.0.4153"
  • Serilog | Version="3.0.1"
  • Serilog.Sinks.Console | Version="4.1.0"
  • Serilog.Sinks.File | Version="5.0.0"

StocksMarketWebAPI

  • Asp.NET Core 7
  • AutoMapper.Extensions.Microsoft.DependencyInjection | Version="12.0.1"
  • Microsoft.AspNetCore.Authentication.JwtBearer | Version="7.0.13"
  • Microsoft.AspNetCore.OpenApi | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.Tools | Version="7.0.13"
  • Serilog.AspNetCore | Version="7.0.0"
  • Serilog.Sinks.MSSqlServer | Version="6.3.0"
  • Swashbuckle.AspNetCore | Version="6.5.0"

HangFireDbContextLibrary

  • Microsoft.EntityFrameworkCore | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.Tools | Version="7.0.13"

SharedServices

  • EPPlus | Version="7.0.0"
  • iTextSharp.LGPLv2.Core | Version="3.4.12"
  • Serilog.AspNetCore | Version="7.0.0"
  • Serilog.Sinks.Debug | Version="2.0.0"
  • Serilog.Sinks.File | Version="5.0.0"

StocksMarketDbContextLibrary

  • Microsoft.EntityFrameworkCore | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.SqlServer | Version="7.0.13"
  • Microsoft.EntityFrameworkCore.Tools | Version="7.0.13"

StocksMarketEntitiesLibrary

  • Microsoft.EntityFrameworkCore | Version="7.0.13"

ModalsLibrary

  • None

Proje Ayağa Kaldırma Adımları, Projenin Genel Çalışma Mantığı Ve Notlar

Projenin Genel Çalışma Mantığı

  • Solition içerisinde 3 adet uygulama ve bu uygulamalr tarafından kullanılan kütüphaneler bulunur. GetStockService ,HangFireApp ve StocksMarketWebAPI uygulamaları temel solition içeriğini oluşturur.
  • StocksMarketWebAPI ve HangFireApp uygulaması birlikte ayağa kalkıp, çalışacak şekilde konfigüre edilmiştir.
  • HangFireApp uygulaması kendi metodu üzerinden GetStockService uygulamasını çalıştırır.
  • HangFireApp uygulaması kendi metodu üzerinden fiyatı değişen hisse senetlerini bulup, bu hisse senetlerine sahip olan ve bu hisse senetlerini takip eden kullanıcılara email atar.
  • HangFireApp uygulaması her ay sonu kullanıcılara işlem özet rapolarını excel ve pdf formatında email olarak gönderir.
  • Fiyatı değşen hisse senetlerinin tespiti için ikinci bir veri tabanı ile eşleştirme işlemi yapılır bu sayede sistem yükü dağıtılmış olur.
  • GetStockService, HangFireApp'in bağımlılığı olarak tanımlanmıştır, bu sayede Web API ve HangFireApp ayağa kalkarken GetStockService uygulamasıda otomatik olarak derlenir.
  • HangFireApp 3 dakikada 1 kez GetStockService uygulamasını çalıştırır.
  • HangFireApp 3 dakikada 1 kez hisse senedi takip ve email servisini çalıştırır.
  • HangFireApp ayda 1 kez SendMailMonthlyReport işini çalıştırır.
  • GetStockService tüm hisseleri çekip, StocksMarketWebAPI uygulamasına istek atıcaktır. (Token ile güvenlik kontrolü)
  • StocksMarketWebAPI uygulaması controller üzerinden aldığı hisseleri otomatik olarak işleyip, veritabanına kayıt edicektir. (Hisse senedi yoksa yeni kayıt ekler, var ise son fiyatını sisteme ekler.)
  • StockMarketWeb API üzerinden alım satım geçmişinizi veya ilgili hisse senedine ait fiyat hareketlerini excel çıktısı olarak alabilirsiniz.

Proje Ayağa Kaldırma Adımları

  1. Projeyi klonlayın.

  2. Projeyi çalıştırmadan önce gerekli paketleri yüklemek için NuGet Paket Yöneticisi'ni kullanarak projenin bağımlılıklarını yükleyin.

  3. Projeyi Default olarak çalıştırmak için:
      a) Projeyi çalıştırın.

  4. Projeyi Manuel olarak çalıştırmak için:
      a) StocksMarketWebAPI uygulamasını çalıştırın.
      b) Ardından GetStockService uygulamasını derleyin.
      c) HangFireApp uygulamasını çalıştırın.

  5. HangFireApp, dakikada bir kez GetStockService uygulamasını çalıştırır. GetStockService, tüm hisseleri çeker ve bu verileri Web API'ye gönderir.

  6. StocksMarketWebAPI uygulaması, aldığı hisseleri otomatik olarak işler ve veritabanına kaydeder (eğer hisse senedi yoksa, yeni kayıt ekler; varsa, son fiyatını günceller).

Notlar

  • Projenin ana parçası çalışsa da, GetStockService uygulamasının PUT yöntemi bir hata verirse, appconfig dosyasındaki BaseUrl değerini güncelleyin. Örnek: "BaseUrl":"https://localhost:7261/api/Stock/SetStocks"

  • Projeyi test etmek için, Postman tarafından oluşturulmuş ve dışa aktarılmış bir koleksiyon dosyasını (Postman V2.1 sürümüyle uyumlu) içe aktarın. Projeyi test etmek için Postman çevresel değişkenler (Env.) içindeki Token ve BaseUrl'i test senaryonuza göre güncelleyin.

  • Veritabanı sorunları için her üç projedeki yapılandırma dosyalarını gözden geçirin ve gerektiğinde Connection String'i kendi ortamınıza göre ayarlayın.

  • Bir çözüm içerisinde üç farklı proje olduğu için add-migration, update-database vb. komutlarını çalıştırırken hatalar alabilirsiniz. Bu hataları önlemek için komutu çalıştırırken hedef projeyi belirtmelisiniz. Örnek: Update-Database -Project StocksMarketWebAPI, add-migration -Project StocksMarketWebAPI migrationName

  • İki adet context nesnesi olduğuna ilişkin bir hata alırsanız, add-migration -Context ContextName vb.. tarzında bir yazım metodu uygulayın.

  • Bazı işlemler için yönetici yetkisi gerekebilir. Yönetici hesabı: { kullanıcı adı: admin, şifre: admin }.

Veritabanı Tasarımı

dbdiagram

Programdan Görseller

Resim 34 Resim 34 Resim 34 Resim 34 Resim 34 Resim 31 Resim 33 Resim 32 Resim 30 Resim 35 Resim 35_2 Resim 35_3 Resim 1 Resim 1_2 Resim 2 Resim 3 Resim 4 Resim 5 Resim 6 Resim 7 Resim 8 Resim 9 Resim 10 Resim 11 Resim 12 Resim 13 Resim 14 Resim 15 Resim 16 Resim 17 Resim 18 Resim 19 Resim 20 Resim 21 Resim 22 Resim 23 Resim 24 Resim 25 Resim 26 Resim 27 Resim 28 Resim 29

About

The aim of this project is to develop a StockMarket Web API application in accordance with enterprise software development processes, clean code writing principles and best practices.

Topics

trading market stock webapp asp-net-core webapi

Resources

Readme
Activity

Stars

3 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages