README.md

Serenity Application Platform

What is the Serenity Platform

Serenity is an ASP.NET Core / TypeScript application platform designed to simplify and shorten the development of data-centric business applications with a service-based architecture.

It aims to make development easier while reducing maintenance costs by avoiding boiler-plate code, reducing the time spent on repetitive tasks, and applying best software design practices.

Quickstart (Serene)

Premium customers should use the StartSharp template which they can download from the Serenity members area.

Ensure you have the necessary requirements installed.

# Install/Update Serene.Templates package.
> dotnet new install Serene.Templates

# Create a new Serene project.
> dotnet new serene -n MySereneApp

# Navigate into your project folder.
> cd MySereneApp/MySereneApp.Web

# Install NPM packages.
> npm i

# Build and run the project.
> dotnet run

That's it! ✨ You can visit http://localhost:5000 (actual port may vary, check the console after dotnet run) to see your running Serene application.

Documentation and Tutorials

See Serenity Developer Guide - https://serenity.is/docs for documentation and step-by-step tutorials.

Serenity Blog:

• https://serenity.is/blog/

Check out the Visual Studio Toolbox Presentation:

• Building Web Apps with the Serenity Platform

Online Demo

https://demo.serenity.is

Contribute / Spread the Word

You may contribute to the project by opening a pull request, adding documentation, sample source code, asking a question or suggesting an improvement, etc. Just open a discussion here with relevant links.

Please help spread the word by posting in blogs, forums, and social media, starring the project on GitHub, or reviewing the Serene extension in VSGallery.

License

Serenity (including its application template Serene) is a free and open-source project with an MIT license, which permits usage in commercial applications.

Premium Packages

We offer premium support packages at https://serenity.is. They also include the StartSharp template with advanced samples, features, and modules.

Visit this document for more information about what is available in premium support and StartSharp.

Custom Development

Custom development options are available from the author and a team of Serenity professionals. Contact us for details.

Video Tutorials by Community Members (not official, some might be out of date)

• Starting Point Videos by @sayuga: https://www.youtube.com/channel/UCHGyxXj-vI32YaRs0v3HvKw
• Youtube Channel of @samdubey: https://www.youtube.com/c/SerenityApplicationFramework
• Introduction to Serene by @samdubey: https://www.youtube.com/watch?v=_AqRl_U_gcw
• Movie Tutorial: https://www.youtube.com/playlist?list=PLMr_-cvwVIMWBsgWWUYdbHxBHPrOSzWVf
• Continuous Deployment on Azure by @samdubey: https://www.youtube.com/watch?v=tcywhS9k9Wc
• Videos in Arabic by @MohamedEbrahimSaad: https://www.youtube.com/watch?v=op15-Q2TDjg