Delvis Soligt

The Ultimate .NET Core MVC Template without heavy lib codes!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Design
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Acknowledgments

About The Project

A lightweight template for building .NET Core MVC applications with a full JavaScript ecosystem available.

Incentives:

• Wanted to have a more lightweight, versatile .NET Core MVC template
• Don't want to use the original MVC template
• Want to use TailwindCSS
• Buitl this MVC template so I can use it for other projects.

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people who have contributed to expanding this template!

(back to top)

Built With

The technologies and tools used within this template.

• .NET MVC
• C#/Razor
• Esbuild
• JavaScript
• TypeScript
• TailwindCSS
• Selenium (Need regularly update Chrome driver NuGet)
• xUnit

(back to top)

Design

.NET MVC is a server-side web application framework. The official MVC template from Microsoft comes with a huge JavaScript and BootStrap library which I think it is cumbersome to maintain. I swapped the library with Node and npm build tools, in this case, esbuild to perform code splitting and bundling. It also supports transpilation from TypeScript to JavaScript and this makes the codebase more versatile and lightweight. Additionally, I can use TailwindCSS to style the web UIs which is extremely handy.

(back to top)

Getting Started

Prerequisites

The list of tools that are used when development.

• npm

  npm install npm@latest -g

• Pnpm

  npm i -g pnpm

• Git
• .NET CLI

Installation

To use this template for personal use or contribution, simply perform the following. A total of 2 terminals are required to get the core components of the application up and running for development.

1. Clone the repo

   git clone https://github.com/data-miner00/DelvisSoligt.git

2. Install Node dependencies

   pnpm i

3. Install NuGet dependencies

   dotnet restore

4. Change directory into DelvisSoligt.Web

   cd src/DelvisSoligt.Web

5. Optionally build TailwindCSS

   pnpm build:css

6. Optionally build JavaScript from TypeScript

   pnpm build:js

7. Watch TailwindCSS

   pnpm watch:css

8. Start or watch MVC project

   dotnet run
   # or
   dotnet watch

9. Build MVC project

   dotnet build

(back to top)

Roadmap

• TypeScript integration
• Unit Test
• Mobile responsive
• Working navigation
• Selenium UI test
• Fix Div soup
• Add fonts
• Authorization
• jQuery

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL3.0 License. See LICENSE for more information.

(back to top)

Acknowledgments

List of resources that are helpful and would like to give credit to.

• Nextjs
• esbuild homepage
• .NET Documentation

(back to top)