https://github.com/jerajo/clients.crud
A coding test project with a .NET Core API and a Vuejs web client.
https://github.com/jerajo/clients.crud
api crud netcore sqlite sqlserver typescript vue
Last synced: about 1 month ago
JSON representation
A coding test project with a .NET Core API and a Vuejs web client.
- Host: GitHub
- URL: https://github.com/jerajo/clients.crud
- Owner: Jerajo
- Created: 2021-03-02T22:04:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-08T15:54:05.000Z (almost 5 years ago)
- Last Synced: 2023-03-06T04:32:59.950Z (almost 3 years ago)
- Topics: api, crud, netcore, sqlite, sqlserver, typescript, vue
- Language: C#
- Homepage:
- Size: 488 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Clients CRUD demo (.NET Core + Vue.js)
A coding test project with a .NET Core API and a Vuejs web client.
## Project Setup
### Prerequisites
Follow the installation instructions for each dependency on their respective official web pages. (link over the dependency name)
[Windows compatible with .NET Core 3.1 runtime or any other compatible system](https://docs.microsoft.com/en-us/dotnet/core/install/windows?tabs=netcore31)
[.NET Core 3.1 LTS (SDK and Runtime)](https://dotnet.microsoft.com/download/dotnet-core/3.1)
[SQL Server 2019 (Developer or Express)](https://www.microsoft.com/en-us/sql-server/sql-server-downloads)
[Node package manager (npm == lts~v14.15.4)](https://nodejs.org/es/download/package-manager/)
### Manual development environment setup
In the root directory of the repository. Open a command prompt of your choice and enter the following commands:
#### 1. _install ef and create the database_
> skip this step if you want to use in-memory database.
```bash
cd Source/
dotnet tool install --global dotnet-ef
dotnet build
dotnet ef database update --project ./Clients.Api
```
#### 2. _install node modules_
```bash
cd Clients.Vuejs/
npm install
```
### Running the projects
To run the API and Vue.js projects, you will need to open a command prompt for each one. Go to the repository path, from there run:
#### 1. _Running the API_
```bash
cd Source/
dotnet run --project ./Clients.Api
```
also you can pass an application argument `migrate` to make the initial migration and run the API.
```bash
dotnet run --project ./Clients.Api -- migrate
```
additionally you can pass the argument `--configuration` to use `SQLIte` instead of `SQLServer` data provider.
```bash
dotnet run --project ./Clients.Api -c MOCK -- migrate
```
if you are using **Visual Studio Code** you can launch the debugger by pressing:
F5
#### 2. _Running the Web Client_
```bash
cd Source/Clients.Vuejs/
npm run serve
```
if you are using **Visual Studio Code** you can run the task `npm: serve - Source/Clients.Vuejs`, by using.
Ctrl + Shift + P then select `Tasks: Run Task` > `npm: serve - Source/Clients.Vuejs`.
## Project details
### General information
This is a demo application using .NET Core 3.1 and Vuejs v3. Consist on a CRUD for the entities Clients and Addresses where each client can have multiple clients.
Here are some information about the architectures, code principles, design patterns and libraries used in this project.
#### Architectures
| API | Web Client |
| :------- | :-------------- |
| N-Layers | Component-Based |
| MVC | |
| Onion | |
#### Code principles
- Clean
- SOLID
- Defensive Coding
#### Design patterns
- Command
- Factory
- Builder
- Dependency Injection
- Repository
- Unit of Work
#### Libraries
| API | Web Client |
| :------------------ | :------------------ |
| EntityFrameworkCore | axios |
| FluentValidations | vee-validate |
| AutoMapper | pikaday |
| Serilog | vue-router |
| GuardClauses | bootstrap-vue |
| OpenApi | vue-class-component |
| Newtonsoft.Json | guid-typescript |
#### Have a great time
I hope you find this material very educational and useful. :-)