Skip to content

Genocs/genocs-library-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

License Build Packages Downloads Contributors Forks Stargazers Issues Discord Gitter Twitter Twitterx LinkedIn

icon

Genocs Library Template

Built to incorporates the most essential packages your projects will ever need. Follows Clean Architecture Principles.

Goals

The goal of this repository is to help developers/companies kickstart their Web Application Development with a pre-built Web Api Template based on Genocs Library nuget Packages. It includes several much needed components and features.

Note that this is a backend application only! The frontend for this application is available in a seperate repository.

Prerequisites

Getting Started

Open up your Command Prompt or PowerShell or "bash" and run the following command.

# To clone the repository
git clone https://github.com/Genocs/genocs-library-template

# To build the nuget package
nuget pack ./src/Package.Template.nuspec -NoDefaultExcludes -OutputDirectory ./out -Version 1.5.1

# To install the template
dotnet new install ./out/Genocs.Library.Template.1.5.1.nupkg

# To 
dotnet new gnx-librawebapi --help
dotnet new gnx-librawebapi --name {MyCompany.MyProject}

# To install the template from nuget
dotnet new install Genocs.Library.Template

# To install a specific version of the template

dotnet new install Genocs.Library.Template::1.5.1

This would install the Genocs Library Web Api Template globally on your machine. Do note that, at the time of writing this documentation, the latest available version is 1.5.1 which is also one of the first stable release version of the package. It is highly likely that there is already a newer version available when you are reading this.

To get the latest version of the package, visit nuget.org

For more details on getting started, read the documentation

Please check the documentation for more details.

How to create a project

Create, build, test and run:

dotnet new i Genocs.Library.Template
dotnet new gnx-librawebapi -n {CompanyName.ProjectName.ServiceName}
cd {CompanyName.ProjectName.ServiceName}
dotnet build ./src/{CompanyName.ProjectName.ServiceName}.WebApi
dotnet build ./src/{CompanyName.ProjectName.ServiceName}.Worker

dotnet test
dotnet run ./src/{CompanyName.ProjectName.ServiceName}.WebApi

How to build the package

To build the package run the following commands:

Official Link

cd ./src
nuget pack
dotnet new u Genocs.Library.Template

dotnet new install ./out/Genocs.Library.Template.1.5.1.nupkg

dotnet new gnx-librawebapi --help
dotnet new gnx-librawebapi --name {MyCompany.MyProject}

Sample application

Run dotnet new -i Genocs.Library.Template then try the following commands.

dotnet new gnx-librawebapi

Miscellaneous

Useful commands:

# How to get the list of installed templates
dotnet new -u

dotnet --list

License

This project is licensed with the MIT license.

Changelogs

View Complete Changelogs.

Community

Support

Has this Project helped you learn something New? or Helped you at work?

Here are a few ways by which you can support.

  • ⭐ Leave a star!
  • 🥇 Recommend this project to your colleagues.
  • 🦸 Do consider endorsing me on LinkedIn for ASP.NET Core - Connect via LinkedIn
  • ☕ If you want to support this project in the long run, consider buying me a coffee!

buy-me-a-coffee

Code Contributors

This project exists thanks to all the people who contribute. Submit your PR and join the team!

genocs contributors

Financial Contributors

Become a financial contributor and help me sustain the project.

Support the Project on Opencollective

Acknowledgements