-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created README.md for NuGet and README fixes (#2)
* Update README.md * Updated project properties --------- Co-authored-by: Kirill Kovalev <kirill.kovalev@abblix.com>
- Loading branch information
1 parent
8fd6a4d
commit 3b9ce76
Showing
6 changed files
with
128 additions
and
29 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| [](https://github.com/Abblix/Templates) | ||
|
|
||
| [](#) | ||
| [](https://learn.microsoft.com/ru-ru/dotnet/csharp/tour-of-csharp/overview) | ||
| [](#) | ||
| [](#) | ||
| [](#) | ||
| [](https://opensource.org/licenses/MIT) | ||
|
|
||
| ⭐ Star us on GitHub — it motivates us a lot! | ||
|
|
||
| [](https://x.com/intent/tweet?text=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Templates%20%23ASPNetCore%20%23Templates%20%23DotNet) | ||
| [](https://www.facebook.com/sharer/sharer.php?u=https://github.com/Abblix/Templates) | ||
| [](https://www.linkedin.com/sharing/share-offsite/?url=https://github.com/Abblix/Templates) | ||
| [](https://www.reddit.com/submit?title=Check%20out%20this%20project%20on%20GitHub:%20https://github.com/Abblix/Templates) | ||
| [](https://t.me/share/url?url=https://github.com/Abblix/Templates&text=Check%20out%20this%20project%20on%20GitHub) | ||
|
|
||
| ## 🚀 About the Templates | ||
|
|
||
| **Abblix ASP.NET Core Templates** includes two powerful templates designed to simplify and accelerate your development process. These templates provide a solid foundation for building modern web applications and identity providers with ASP.NET Core. | ||
|
|
||
| - **[ASP.NET Core WebAPI with React and Vite Template](https://github.com/Abblix/Templates/blob/master/ReactTemplate/README.md)**: | ||
| This template serves as a starting point for creating an ASP.NET Core WebAPI project combined with a React frontend using TypeScript and Vite. It establishes a fundamental project structure and essential configurations, enabling developers to kickstart their applications swiftly. | ||
| - **[OpenID Connect Provider Template](https://github.com/Abblix/Templates/blob/master/OpenIDProviderTemplate/README.md)**: | ||
| This template is tailored for building an OpenID Connect Provider using ASP.NET Core in conjunction with the Abblix OIDC Server. It includes the core configurations and components needed to set up a functional identity provider, streamlining the process for developers to implement secure authentication solutions. | ||
|
|
||
| ## 📋 Prerequisites | ||
|
|
||
| Before you begin using the Abblix ASP.NET Core Templates, ensure that your development environment is properly set up with the following tools: | ||
|
|
||
| - **[.NET 8 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)**: This SDK is essential for building and running ASP.NET Core applications. It includes the necessary compilers, libraries, and tools to develop, test, and deploy your applications. Make sure to download and install the latest version to fully leverage the capabilities of the templates. | ||
| - **[Node.js and npm](https://nodejs.org/)**: Node.js is required to manage the frontend dependencies for projects using React and Vite. npm (Node Package Manager) comes bundled with Node.js and is used to install and manage these dependencies. Having Node.js and npm installed ensures that you can seamlessly integrate and build the frontend parts of your application, especially when using modern JavaScript frameworks and tools like React and Vite. | ||
|
|
||
| ## 📝 Installing the Templates | ||
|
|
||
| To start using the Abblix ASP.NET Core Templates, you can install them in your development environment either from NuGet or from a local `.nupkg` file. | ||
|
|
||
| ### From NuGet | ||
|
|
||
| If you have access to NuGet.org, this method is preferable. Run: | ||
|
|
||
| ```bash | ||
| # Install the template package from NuGet | ||
| dotnet new install Abblix.Templates | ||
| ``` | ||
|
|
||
| This command downloads and installs the latest version of the templates directly from NuGet.org. | ||
|
|
||
| ### From a Local `.nupkg` File | ||
|
|
||
| If you don't have access to NuGet.org, but you have a local `.nupkg` file, run: | ||
|
|
||
| ```bash | ||
| # Install the template from the local .nupkg file | ||
| # Replace "path/to/Abblix.Templates.x.x.x.nupkg" with the actual file path | ||
| # This allows you to install the template locally without accessing an online repository | ||
| dotnet new install path/to/Abblix.Templates.x.x.x.nupkg | ||
| ``` | ||
|
|
||
| This method allows you to install the template manually using the `.nupkg` file. | ||
|
|
||
| ## 📃 License | ||
|
|
||
| This project is licensed under the MIT License. You can review the full license text at the following link: [MIT License](https://opensource.org/licenses/MIT). | ||
|
|
||
| ## 🙏 Acknowledgements | ||
|
|
||
| We would like to acknowledge the following technologies that have been instrumental in the development of the Abblix ASP.NET Core Templates: | ||
|
|
||
| - **[ASP.NET Core](https://docs.microsoft.com/aspnet/core)**: A powerful framework for building modern web applications, providing the backbone for our server-side implementations. | ||
| - **[React](https://reactjs.org/)**: A leading JavaScript library for creating dynamic user interfaces, which has been key to the frontend structure of our templates. | ||
| - **[TypeScript](https://www.typescriptlang.org/)**: A superset of JavaScript that adds static types, helping us write more reliable and maintainable code. | ||
| - **[Vite](https://vitejs.dev/)**: A fast and modern build tool that has significantly improved the development experience for our projects. | ||
|
|
||
| ## 🔗 Key Contacts & Resources | ||
|
|
||
| For more details about our products, services, or any general information regarding the Abblix OIDC Server, feel free to reach out to us. We are here to provide support and answer any questions you may have. Below are the best ways to contact our team: | ||
|
|
||
| - **[Email](mailto:support@abblix.com)**: Send us your inquiries or support requests via support@abblix.com. | ||
| - **[Website](https://www.abblix.com/abblix-oidc-server)**: Visit the official page for more information. | ||
| - **[GitHub Repository](https://github.com/Abblix/Oidc.Server)**: Explore the source code and contribute to the Abblix OIDC Server. | ||
| - **[Getting Started Guide](https://github.com/Abblix/Oidc.Server.GettingStarted)**: Follow our step-by-step guide to create an OpenID Connect provider using ASP.NET MVC. | ||
| - **[Abblix Documentation](https://docs.abblix.com/docs)**: Access detailed documentation for all our products and services. | ||
|
|
||
| We look forward to assisting you and ensuring your experience with our products is successful and enjoyable! | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters