diff options
| author | Syndamia <kamen.d.mladenov@protonmail.com> | 2021-05-11 14:00:35 +0300 |
|---|---|---|
| committer | Syndamia <kamen.d.mladenov@protonmail.com> | 2021-05-11 14:00:35 +0300 |
| commit | 5436337b45e98b6001bbae0c6d36fe004ff1e55c (patch) | |
| tree | e3823f559b4ce82b0aaef5ccfd78d6a701e9d0fd | |
| parent | 7534ba1bd08cb84f8df32d7c64f6de40257eb8f0 (diff) | |
| download | it-kariera-exam-template-5436337b45e98b6001bbae0c6d36fe004ff1e55c.tar it-kariera-exam-template-5436337b45e98b6001bbae0c6d36fe004ff1e55c.tar.gz it-kariera-exam-template-5436337b45e98b6001bbae0c6d36fe004ff1e55c.zip | |
Fixed typos and reworded a bit some stuff
| -rw-r--r-- | README.md | 14 |
1 files changed, 7 insertions, 7 deletions
@@ -34,14 +34,14 @@ The following sections explain the usage if these scripts. ### rename-project -As the title suggest, with this tool you could rename the whole project. It renames all of the files, folders and text inside files (so usings, namespaces, class names, variable names, etc.) that have the default name (`ExamTemplate`) , or a given name, to another given name. +As the title suggest, with this tool you could rename the whole project. It renames all of the files, folders and text inside files (so usings, namespaces, class names, variable names, etc.) to another given name. Example: renaming the default (`ExamTemplate`) to `CarShop` ```bash ./rename-project.sh CarShop ``` -If you've already renamed your project and want to change the name yet again, just give the script two paramters: the first one is the current name and the second - the new name. +If you've already renamed your project and want to change the name yet again, just give the script two parameters: the first one is the current name and the second - the new name. Example: renaming the project called `CarShop` to `BookShop` ```bash @@ -52,11 +52,11 @@ You could rename stuff manually, but this and all other scripts rely on the nami ### add-feature-template -This is a scaffolding-like script. With it, you type in some information about the project and your desired feature and it generates most files you'll need in all layers (Data, service, Web). +This is a scaffolding-like script. With it, you type in some information about the project and your desired feature and it generates most files you'll need in all layers (Data, Service, Web). -The script is meant to give you the inital stuff you'll need. Outside of some created files and their **preset contents** (simple default implementations), the script can't do anything else. Another limitation is references: it can't detect and add `using` statements, so if you use some fancy data type, make sure to add the appropriate `using`! +The script is meant to give you the initial stuff to get you started. Outside of creating some files and their **preset contents**, the script can't do anything else. Another limitation is references: it can't detect and add `using` statements, so if you use some fancy data type, make sure to add the appropriate `using`! - **Example**: Let's say you [renamed](#rename-project) your project to `CarShop` and need a Car class that has a Brand, Model and Year. + **Example**: Let's say you [renamed](#rename-project) your project to `CarShop` and need a `Car` class that has a `Brand`, `Model` and `Year`. - The first argument is the project name, then the name of your desired feature (should be the same name you would use when creating a database model) and then the different properties in the format `"type Name"`. ```bash ./add-feature-template.sh CarShop Car "string Brand" "string Model" "int Year" @@ -89,7 +89,7 @@ The script will create (and edit where specified) the following files: │ └─ _ViewImports.cshtml (Only edited; Adds reference to the Car View Models namespace) └─ Startup.cs (Only edited; Adds dependency injection configuration for CarService) ``` -All of the models have all given properites **and a "Guid Id" property**. Only the Create models don't have the "Guid Id" property. +All of the models have all given properties **and a "Guid Id" property**. Only the Create models don't have the "Guid Id" property. Controller and Service have **very basic** CRUD of the model. No view links are added, so you'll need to provide them (and to test out if everything work: just edit the link in the browser). @@ -99,7 +99,7 @@ There are some configs that I've made that you may want to change. This section ### Database -The project is made to use [PostgreSQL](https://www.postgresql.org/) by default. Since not everyone would want to use that, here are some steps for other databases. **Sidenote**: delete the migrations if you want to use another database and add new ones! +The project is made to use [PostgreSQL](https://www.postgresql.org/) by default. Since not everyone would want to use that, here are some steps for other databases. **Side note**: delete the migrations if you want to use another database and add new ones! Using MySQL: 1. Install the [MySql.Data.EntityFrameworkCore](https://www.nuget.org/packages/MySql.Data.EntityFrameworkCore/) NuGet package in **both** `ExamTemplate/Web` and `ExamTemplate/Data` |
