Helping you quickly build amazing sites
Clone or download
Permalink
Failed to load latest commit information.
build
docs
src Merge branch 'dev' of https://github.com/IntelliTect/Coalesce into dev Nov 16, 2018
.gitattributes
.gitignore
CONTRIBUTING.md
Coalesce.sln
Coalesce2.0Changes.md
DOC_ENVIRONMENT.md
ENVIRONMENT.md
README.md
appveyor.yml
coalesce-ko.json
coalesce-vue.json
license.txt

README.md

Coalesce

Home · Documentation · Get Started · Builds

Coalesce is a framework for rapid-development of ASP.NET Core web applications. It works from the Entity Framework Core data model that you design, automating the creation of the glue - DTOs, API Controllers, and TypeScript - that sit between your data and the UI of your application.

Fundamentals

  • Code Generation: Write your data model. We'll build the DTOs, API controllers, and TypeScript files that are needed to start building a front-end UI right away. A full suite of CRUD endpoints are generated with inner-workings that are overridable.
  • Extensibility: We don't want to box you in - one of the primary goals of Coalesce is to be as flexible as possible. If something that Coalesce is doing doesn't quite fit your needs, you should be able to configure it or override it easily. You should never feel like you need to eject from the framework.
  • Security: Coalesce is designed with security in mind. All classes, properties, and methods can be restricted per-role, or their data even hidden entirely from the client. Row-level security can be implemented using custom data sources. The guiding principal here is that it should always be easy to know exactly what parts of your data Coalesce is exposing for you.

Features

  • CRUD for EF models: For each DbSet<> on your DbContext, a full set of /get, /save, /delete, /count, and /list endpoints are created. Each can be secured or omitted entirely via attributes, or customized with much greater granularity with custom Data Sources and/or Behaviors. /list and /count have paging, searching, sorting, and filtering built-in.
  • Endpoints for Methods: For client requests that don't fit the mold of a simple CRUD action against an entity, place methods on your entities and annotate with [Coalesce] - controllers and TypeScript will be built for those as well. Have functions that don't belong on an entity class? Place them in a service class marked with [Coalesce] instead - you'll get the same set of features.
  • Choose your Front-end: Coalesce supports both Vue and Knockout. While the paradigms used in the TypeScript code generated for each are quite different, they both make requests against the same API. At the end of the day, they both can accomplish the same tasks. The code for Vue isn't quite complete yet, but it has enough features now that it is feasible to start building apps with it - documentation is still forthcoming (#80).
  • ... and more! Check out the documentation to see all of Coalesce's features in-depth: http://coalesce.readthedocs.io

Get Started

The best way to get started with Coalesce is using the dotnet new templates that have been created:

  • Knockout: dotnet new --install IntelliTect.Coalesce.KnockoutJS.Template; dotnet new coalesceko
  • Vue: dotnet new --install IntelliTect.Coalesce.Vue.Template; dotnet new coalescevue

After you create your project, you should start reading through the Documentation to see all the things that Coalesce can do.

Builds

channel build IntelliTect.Coalesce coalesce-vue
master Build status NuGet
dev Build status MyGet npm

Contributing

See the contribution guide here.