https://github.com/peachpiecompiler/peachpie-templates
Peachpie project templates.
https://github.com/peachpiecompiler/peachpie-templates
dotnet peachpie peachpiecompiler php templates
Last synced: about 2 months ago
JSON representation
Peachpie project templates.
- Host: GitHub
- URL: https://github.com/peachpiecompiler/peachpie-templates
- Owner: peachpiecompiler
- Created: 2017-04-23T01:04:02.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T13:03:43.000Z (10 months ago)
- Last Synced: 2024-08-22T14:38:07.632Z (10 months ago)
- Topics: dotnet, peachpie, peachpiecompiler, php, templates
- Language: C#
- Size: 1.72 MB
- Stars: 12
- Watchers: 6
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## PeachPie Templates
This repository contains various `dotnet` project templates to be used for creating PeachPie compiled applications.
## Using templates
0. Install peachpie templates via: `dotnet new -i "Peachpie.Templates::*"`
1. Create a project based on chosen template e.g.: `dotnet new console -lang PHP`
2. Restore packages for the newly created project: `dotnet restore`
3. Run the project: `dotnet run`
> You need to install PeachPie templates only once. They get stored in ~HOME/.templateengine cache.
## Prerequisites
- .NET SDK 6.0 or later
- PowerShell (only for building)
## Contributing templates & building
### Adding a new template:
- Go to `./src/Content`
- Create a new folder with name mathing the template's `shortName`
- Fill the folder with all that is required for a template
- [Official documentation on template creation](https://github.com/dotnet/templating/wiki/%22Runnable-Project%22-Templates)
- [Tutorial on MSDN](https://blogs.msdn.microsoft.com/dotnet/2017/04/02/how-to-create-your-own-templates-for-dotnet-new/)
- [Short introduction on rehansaeed.com](http://rehansaeed.com/custom-project-templates-using-dotnet-new/)
### Building & testing
- Invoke `.\build.ps1` which calls a [build](https://github.com/peachpiecompiler/peachpie-templates/tree/master/build/build.ps1) (1) and a [test](https://github.com/peachpiecompiler/peachpie-templates/tree/master/tests/test.ps1) (2) script
- 1: Packages all templates into a nuget package (see `/out/Peachpie.Templates.x.y.z.nupkg`)
- 2: Installs the the templates package to current `.templateengine` cache
- 2: Tries to create a project from each one, restore it, and build it
- After invoking the build script your template should be listed among `dotnet new -all`