Jlll1 / Sutil-Template

Set of `dotnet new` templates for creating Sutil applications
MIT License
1 stars 2 forks source link

Expand readme with information on how to run the project #6

Open Jlll1 opened 2 years ago

Jlll1 commented 2 years ago

README should include brief overview of Fake targets the templates provide

DejanMilicic commented 2 years ago

These are the steps I used for the Sutil-Safe template:

  1. Install the template

    dotnet new -i Sutil.Template
  2. Scaffold Sutil-Safe project

    dotnet new Sutil-Safe -n <ProjectName>
  3. Restore packages

    dotnet tool restore
  4. Run it

    dotnet run
  5. Access it on http://localhost:8080/

Jlll1 commented 2 years ago

We also provide dotnet run test, dotnet run clean and dotnet run install-client (although I have some doubts whether we need the last one or not). I would love to have these mentioned in the readme to bring awareness to them for people who are not familiar with Fake.

DejanMilicic commented 2 years ago

Can you please explain in which specific scenario one might want to call install-client (that would be equivalent to npm install) explicitly?