| @@ -1,2 +1,74 @@ | |||
| # gRPC-project | |||
| # Spotify service | |||
| Welcome to our Spotify service application, where we will guide you through the setup of the project, an introduction to the technologies used in the project | |||
| - [Description](#description) | |||
| - [Setup](#setup) | |||
| - [Testing](#testing) | |||
| - [Tools](#tools) | |||
| # Description | |||
| Blazor & WASM in combination to get statistics from Spotify API for performing the song analysis. With separate microservices for auth, Spotify, user data tracking, and application, connected through gRPC with Polly. [git](https://git.dilig.net/nemanja.grkovic/NemAn) | |||
| ## Tech stack | |||
| For this project we used Blazor WASM (WebAssembly) on the frontend and .NET 6 on the backend, we used MongoDB for the database | |||
| ## Development environment | |||
| - [Visual Studio](https://visualstudio.microsoft.com/downloads/) | |||
| - [NuGet](https://www.nuget.org/packages) | |||
| - [Postman](https://www.postman.com/) | |||
| - [Git](https://git-scm.com/downloads) | |||
| - [Git-flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/) | |||
| - [Compass - MongoDB](https://www.mongodb.com/try/download/community) | |||
| # Setup | |||
| Here we will show you how to set up project and run it in localhost. | |||
| - [Database setup](#database-setup) | |||
| - [Project setup](#project-setup) | |||
| - [Database initialization](#database-initialization) | |||
| ## Database setup | |||
| Please follow the official tutorial on installing and running the latest Mongo database which can be found on this link: | |||
| > https://docs.mongodb.com/manual/tutorial/install-mongodb-on-windows/ | |||
| ## Project setup | |||
| In order to run our project you need to clone it from [git](https://git.dilig.net/nemanja.grkovic/NemAn) first. Open terminal (cmd and powershell work as well) in folder that you want this project to be and run command | |||
| > git clone https://git.dilig.net/nemanja.grkovic/NemAn | |||
| After cloning the project, it is necessary to set up git-flow for that folder for easier project organization, and you will do that by following the instructions - [Git-flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/) | |||
| When you have finished the necessary setup, you can start the projects, the current alternative is to start each separately, docker soon. | |||
| - to do | |||
| ## Database initialization | |||
| - to do | |||
| # Testing | |||
| Here we will show you how to run tests and see code coverage. | |||
| - to do | |||
| # Tools | |||
| Here we will go through tools that we use in this project. | |||
| - [gRPC](#gRPC) | |||
| - [Polly](#Polly) | |||
| - [Background worker](#Background-worker) | |||
| ## Background-worker | |||
| - to do | |||
| ## gRPC | |||
| - to do | |||
| ## Polly | |||
| - to do | |||