https://github.com/devconn99/nucleus
Vue startup application template that uses ASP.NET Core API layered architecture at the back-end and JWT based authentication
https://github.com/devconn99/nucleus
asp-net-core bootstrap bootstrap-vue entity-framework-core jwt-auth swagger typescript vue vuejs vuetify
Last synced: 4 months ago
JSON representation
Vue startup application template that uses ASP.NET Core API layered architecture at the back-end and JWT based authentication
- Host: GitHub
- URL: https://github.com/devconn99/nucleus
- Owner: devconn99
- License: mit
- Created: 2019-12-19T10:27:35.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-10-29T18:01:49.000Z (over 3 years ago)
- Last Synced: 2025-06-02T06:28:38.642Z (9 months ago)
- Topics: asp-net-core, bootstrap, bootstrap-vue, entity-framework-core, jwt-auth, swagger, typescript, vue, vuejs, vuetify
- Language: C#
- Homepage:
- Size: 1.37 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nucleus
Web API startup template with a Vue Client application.
## Requirements
- Vue CLI v3.x or later.
- Nodejs v10.x or later.
- Visual Studio 2019 v16.3 or later **for Windows**.
- Visual Studio 2019 for Mac v8.3 or later **for macOS**.
## How to Start?
### Local Environment
- Select `Nucleus.Web.Api` project "**Set as Startup Project**"
- Open "**Package Manager Console**" and select default project as `src/Nucleus.EntityFramework`
- Run `update-database` command to create database.
- Run(F5 or CTRL+F5) Web API project first
- Run `yarn` command at location `src/Nucleus.Web.Vue` to install npm packages.
- Run `yarn serve` command to run Vue application.
- Admin user name and password : `admin/123qwe`
### Run with Docker
- Run `docker-compose build` command.
- Run `docker-compose up -d` command to run application.
- Go to `http://localhost:36221`
#### To change the environment
- Run `docker-compose -f docker-compose-production.yml build` command.
- Run `docker-compose -f docker-compose-production.yml up -d` command
- Go to `http://localhost:36211`
## Vue Application Screenshots
### Login Page
### Register Page
### Forgot Password Page
### List Pages
### Create/Edit Pages
## ASP.NET Core Web API
### Project solution:
### Swagger UI
# Document
## Swagger UI Authorize
You can login on swagger ui by using a bearer token. So you can make requests to authorized end-points. Check the following steps.
- In swagger ui, execute `api/login` to get a bearer token.
- Copy bearer token that is in `api/login` response.
- Click `Authorize` button in swagger ui page.
- Enter the token like `Bearer ` and click `Authorize`.
- Now you can make requests to authorized end-points.
## Adding New Language
- Add json file to store language keys and values to `Nucleus\src\Nucleus.Web.Vue\src\assets\localizations\your_language.json`
- Copy `en.json` content and translate the values to target language.
- Add country flag to `Nucleus.Web.Vue\src\assets\images\icons\flags\your_country.png`. Get images from http://www.iconarchive.com/show/flag-icons-by-gosquared.html
- Add language to language selection menu in `Nucleus\src\Nucleus.Web.Vue\src\account\account-layout.vue` and `Nucleus\src\Nucleus.Web.Vue\src\admin\components\menu\top-menu\top-menu.vue` like following
**account-layout.vue**
````html
![]()
{{selectedLanguage.languageName}}
mdi-menu-down
English
Türkçe
````
**top-menu.vue**
````html
![]()
{{selectedLanguage.languageName}}
mdi-menu-down
English
Türkçe
````
## Adding New Permission
- All definitions are made in `DefaultPermissions`.
- First add permission name as const like `public const string PermissionNameABC = "Permissions_ABC";`.
- Add a permission entity that type `Permission.cs` class and give a hard-coded guid id.
- Last, add this permission variable to `DefaultPermissions.All()` method.
###
### Tags & Technologies
- [ASP.NET Core Web API](https://docs.microsoft.com/en-us/aspnet/core/web-api/?view=aspnetcore-2.1)
- [Entity Framework Core](https://docs.microsoft.com/en-us/ef/core/)
- [ASP.NET Core Identity](https://docs.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.identity?view=aspnetcore-2.1)
- [JWT (Bearer Token) Based Authentication](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.JwtBearer/)
- [Automapper](https://automapper.org/)
- [Serilog](https://serilog.net/)
- [Swagger](https://swagger.io/)
- [ASP.NET Core Test Host](https://www.nuget.org/packages/Microsoft.AspNetCore.TestHost)
- [Authorization & Authentication](https://docs.microsoft.com/en-us/aspnet/core/security/?view=aspnetcore-2.1)
- [Exception Handling & Logging](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/error-handling?view=aspnetcore-2.1)
- [Vue.js](https://vuejs.org/)
- [Vue Router](https://router.vuejs.org/)
- [Vuetify](https://vuetifyjs.com/en/)
- [Vue i18n](https://kazupon.github.io/vue-i18n/)