From 6ca6aec580f59e94cc01517e2c9521708b055f9d Mon Sep 17 00:00:00 2001 From: Syndamia Date: Sat, 8 May 2021 19:09:16 +0300 Subject: Added getting started and structure information about the template --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index e467ba0..3ab7065 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,26 @@ A template that could be useful for the final IT-kariera exam in 2021 +## Getting started + +Outside of having installed and configured ASP.NET and a database, all you need to do is: +- Create an `appsettings.Develoment.json` file in `ExamTemplate/Web` that is a direct copy of `appsettings.json`, but you put in your connection string +- Optional: Change the database the project uses (refer to [Database](#Database)) + +The template is setup to automatically apply migrations and it comes by default with some. + +## Structure + +This project uses some main layers. Those layers are the projects inside the solution. Their purpose is: +- Common: Mainly constants and things that could be needed everywhere in the app +- Data: Contains the project context, the context (database) models and migrations +- Service: Contains the business logic, does stuff with the database +- Web: the whole front-end - Views, View models and Controllers + +In some layers you have `Configurations` (Web and Service). Put your Automapper configurations there. + +The `css` files can be found in `ExamTemplate/Web/wwwroot/css/`. The main stuff are put in `styles.css` and that's where you probably should put your own stuff. + ## Notes There are some configs that I've made that you may want to change. This section explains them. -- cgit v1.2.3