Skip to content

Latest commit

 

History

History
37 lines (32 loc) · 2.76 KB

README.md

File metadata and controls

37 lines (32 loc) · 2.76 KB
Raw

MvcKickstart

A base site template I use to start a new asp.net mvc project. This is a .net 4.5, asp.net mvc 4 project.

Overview

This project includes the following:

  • Basic user login, registration, and forgot password screens & logic.
  • A general 500 error page and 404 page are wired up. The 404 page can easily be customized to include suggested pages.
  • A basic admin area, to help directory/file naming conventions for scripts & stylesheets for areas.

Conventions

  • Attribute routing - All routes are named like MyController_MyAction or MyArea_MyController_MyAction.
  • There is no ~/scripts directory. The mvc team should have moved that directory to ~/content/js, where it belongs. That is where you'll find script files in this template.
  • All actions can have their own js and less file. These files will automatically be loaded via _ViewStart.cshtml. If the files do not exist, the site will not fail. The default convention is to place a file named the same as the action, inside a folder named the same as the controller.
    • Eg. ~/content/js/Account/Login.js and ~/content/js/Admin/Home/Index.js
    • Similarly: ~/content/less/Account/Register.less and ~/content/less/Admin/Users/Index.less
  • All data querying should be done inside the the following using block. This allows us to adjust RavenDb cache durations dynamically.
using (RavenSession.GetCachingContext()) {
    // TODO: Add your query code here
}
  • The site takes advantage of the mythical donut caching technique via the MVC donut caching library. Content should be cached via the ConfiguredOutputCache attribute. The idea with that attribute is that the cache duration can be controlled via an admin screen.

Additional Information

  • This project incorporates tracking internal metrics via statsd. It's good to know how your app is behaving. If you don't have statsd setup, you should. If you still don't want it, removing the "Metrics:*" keys from appSettings will disable metric tracking.
  • Unit testing is built into this solution. Please use what I have as a starting point.
  • Some technology choices:
    • RavenDb is the datalayer of choice. If you have problems with that, you can easily swap it out for something less enjoyable.
    • Asset bundling and minification is handled by cassette. The built in asp.net bundler sucks in comparison.
    • This template uses bootstrap for a UI starting point. Enjoy...
    • I use various parts of Service Stack throughout this project. Service Stack is to asp.net projects as Resharper is to Visual Studio.