Skip to content

Commit

Permalink
Merge pull request #1551 from microsoft/dev
Browse files Browse the repository at this point in the history
Sync from dev
  • Loading branch information
sibille authored Jul 20, 2020
2 parents 3b191a9 + 2bdc374 commit 13db8e3
Show file tree
Hide file tree
Showing 391 changed files with 9,829 additions and 8,682 deletions.
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -293,6 +293,7 @@ paket-files/

# VSCode custom workspace settings
.vscode/
!/templates/**/.vscode

# CodeRush
.cr/
Expand Down Expand Up @@ -334,10 +335,13 @@ ASALocalRun/

# Ignore compiled files from the extension
**/extension/logs/
**/extension/.vscode-test/
**/out/
!src/extension/locales/**/out/
src/extension/package.nls.*.json
**/react/
**/dist/
**/distVsix/
**/node_modules/
**/build/
**/package-lock.json
Expand Down
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[submodule "src/CoreTemplateStudio"]
path = src/CoreTemplateStudio
url = https://github.com/Microsoft/CoreTemplateStudio.git
branch = dev
branch = release
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ While we're grateful for any and all contributions, we don't want you to waste a
Every contribution has to come with:

- Before starting coding, **you must open an issue** and start discussing with the community to see if the idea/feature is interesting enough.
- A documentation page in the [documentation folder](https://github.com/Microsoft/WebTemplateStudio/tree/master/docs) if applicable.
- A documentation page in the [documentation folder](https://github.com/Microsoft/WebTemplateStudio/tree/release/docs) if applicable.
- Unit tests (If applicable, or an explanation why they're not)

- If you've changed the UI:
Expand Down
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,35 @@ are merged together by [Core Template Studio](https://github.com/Microsoft/CoreT
| Branch | Build Status |
| :------ | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: |
| dev | [![Build Status](https://winappstudio.visualstudio.com/Vegas/_apis/build/status/WebTemplateStudio%20-%20CI%20and%20Deploy?branchName=dev)](https://winappstudio.visualstudio.com/Vegas/_build/latest?definitionId=158&branchName=dev) |
| staging | [![Build Status](https://winappstudio.visualstudio.com/Vegas/_apis/build/status/webTS/webts.staging.version.create?branchName=staging)](https://winappstudio.visualstudio.com/Vegas/_build/latest?definitionId=161&branchName=staging) |
| master | [![Build Status](https://winappstudio.visualstudio.com/Vegas/_apis/build/status/WebTemplateStudio%20-%20CI%20and%20Deploy?branchName=master)](https://winappstudio.visualstudio.com/Vegas/_build/latest?definitionId=158&branchName=master) |
| release | [![Build Status](https://winappstudio.visualstudio.com/Vegas/_apis/build/status/webTS/webts.staging.version.create?branchName=release)](https://winappstudio.visualstudio.com/Vegas/_build/latest?definitionId=161&branchName=release) |

# Documentation
Web Template Studio (WebTS) documentation is divided into three areas.


## General
Everyone should read these.

- [Installing the extension](/docs/install.md)
- [Core Concepts](/docs/concepts.md)

## Using WebTS to build apps
These will help if using WebTS to build apps.

- [Front-end frameworks](docs/generated-apps/frontend-frameworks/readme.md)
- [Back-end frameworks](docs/generated-apps/backend-frameworks/readme.md)
- [Pages](docs/generated-apps/pages/readme.md)
- [Services](docs/generated-apps/services/readme.md)
- [Deployment of the generated apps](docs/generated-apps/deployment.md)


## Working on WebTS
These will help if you want to know more about WebTS or contribute to the project.

- [Application Arquitecture](docs/contributing/application-architecture.md)
- [Getting started with the codebase](/docs/contributing/getting-started-developers.md)
- [Terminology for developers](/docs/terminology.md)
- [Templates](./contributing/templates.md)
- [Accessibility](./contributing/accessibility.md)

## SHA256

Expand Down Expand Up @@ -57,7 +78,7 @@ I need a full-stack web app that is deployed on Azure App Service Web App.

Web Template Studio approaches full-stack web app creation using the following three attribute sets:

- **Frameworks**: First, which frameworks do you want to use for your frontend and backend? We currently support three frameworks for frontend: _[React](https://reactjs.org/)_, _[Angular](https://angular.io/)_, _[Vue.js](https://vuejs.org/)_ and three frameworks for backend: _[Node](https://nodejs.org/en/)_, _[Flask](http://flask.pocoo.org/)_ and _[Moleculer](https://moleculer.services/)_. We also provide a dependency checker to make sure you have the required version of Node and/or Python installed.
- **Frameworks**: First, which frameworks do you want to use for your frontend and backend? We currently support three frameworks for frontend: _[React](https://reactjs.org/)_, _[Angular](https://angular.io/)_, _[Vue.js](https://vuejs.org/)_ and four frameworks for backend: _[Node](https://nodejs.org/en/)_, _[Flask](http://flask.pocoo.org/)_, _[Moleculer](https://moleculer.services/)_ and _[ASP.NET Core](https://dotnet.microsoft.com/apps/aspnet)_. We also provide a dependency checker to make sure you have the required version of Node, Python and/or .NET Core installed.
- **App pages**: Next, to accelerate app creation, we provide a number of app page templates that you can use to add common UI pages into your new app. The current page templates include: _blank page_, common layouts (*e.g., master detail) and pages that implement common patterns (*e.g., grid, list). Using the wizard, add as many of the pages as you need, providing a name for each one, and we'll generate them for you.
- **Cloud Services**: Lastly, you specify which Azure cloud services you want to use, and we'll build out the framework for the services into your app. Currently supported services cover storage (_Azure Cosmos DB_), and hosting (_Azure App Service_).

Expand Down Expand Up @@ -101,6 +122,7 @@ The extension does [log basic telemetry](docs/telemetry.md) for what is being se
- [Node.js](https://nodejs.org/en/)
- [Flask](http://flask.pocoo.org/)
- [Moleculer](https://moleculer.services)
- [ASP.NET](https://dotnet.microsoft.com/apps/aspnet)

## Acknowledgments

Expand Down
119 changes: 0 additions & 119 deletions RELEASENOTES.md

This file was deleted.

2 changes: 1 addition & 1 deletion _build/CoreTemplateStudio.local.release.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,6 @@
"82B4B76E0A82BCBA2DE619851CF3EB205C233BFB1A4135EC4E05329D8258DC8B30408B21B827EFF3D6008BBFBAFB115E4AD72DE66988888A44BE02CD74A4BE5F",
"26859EB6CDE0744E0B5DA300681265837D0B9F8CFCBB8071C914367EF5C6E14EA806BA770281F64077536C97F477BF55AE7083EEC93F0EC376DA6D357F1F6699"
],
"AllowedPackages": [ "38B3095D8E46591DB6BDF8A6C9816AA50AF486124649F23B86306482B8C62EA5" ],
"AllowedPackages": [ "B0039A831A7CBCA9CB966CC3F9013D8E89F48429E53ED4B06BD8938ADCEAF6E3" ],
"BreakingChangesVersions": []
}
2 changes: 1 addition & 1 deletion _build/build-extension.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ echo

echo -e "${magenta}Building extension ${nc}"
echo
yarn --cwd ../src/extension build
yarn --cwd ../src/extension webpack


3 changes: 3 additions & 0 deletions _build/createLocalVsix.sh
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ sh ./build-client.sh
# Build the cli in release
sh ./build-coretscli.sh "release"

# Build Webpack bundle
yarn --cwd ../src/extension webpack-prod

# Create vsix package
echo -e "${magenta}Creating vsix package ${nc}"
echo
Expand Down
27 changes: 27 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Documentation
Web Template Studio (WebTS) documentation is divided into three areas.


## General
Everyone should read these.

- [Installing the extension](/docs/install.md)
- [Core Concepts](/docs/concepts.md)

## Using WebTS to build apps
These will help if you are using WebTS to build apps.

- [Front-end frameworks](docs/generated-apps/frontend-frameworks/readme.md)
- [Back-end frameworks](docs/generated-apps/backend-frameworks/readme.md)
- [Pages](docs/generated-apps/pages/readme.md)
- [Services](docs/generated-apps/services/readme.md)
- [Deployment of the generated apps](docs/generated-apps/deployment.md)


## Working on WebTS
These will help if you want to know more about WebTS or contribute to the project.

- [Application Arquitecture](docs/contributing/application-architecture.md)
- [Getting started with the codebase](/docs/contributing/getting-started-developers.md)
- [Templates](./contributing/templates.md)
- [Accessibility](./contributing/accessibility.md)
8 changes: 5 additions & 3 deletions docs/acknowledgments.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Acknowledgments

Microsoft Web Template Studio was initially built by a great group of interns from the Microsoft Garage. This full list of individuals that helped build the project during the first quarter of 2019.
Microsoft Web Template Studio was initially built by two great groups of interns from the Microsoft Garage. This full list of individuals that helped build the project.

## First group (first quarter of 2019):

**Design Intern**

Expand Down Expand Up @@ -31,7 +33,7 @@ Microsoft Web Template Studio was initially built by a great group of interns fr
[Clint Rutkas](https://www.linkedin.com/in/clintrutkas/),
[Stephane Morichere-Matte](https://www.linkedin.com/in/stephanemoricherematte/)

Microsoft Web Template Studio is currently built and maintained by a new group of interns from the Microsoft Garage. This full list of individuals that helped build the project during the summer quarter of 2019.
## Second group (summer quarter of 2019):

**Design Intern**

Expand All @@ -46,7 +48,7 @@ Microsoft Web Template Studio is currently built and maintained by a new group o
[Tanya Tan](https://www.linkedin.com/in/tanya-tan-programmer/),
[Ali Khamesy](https://www.linkedin.com/in/ali-khamesy-038003158/)

**Program Manager Intern**
**Program Manager Intern**

[Lea Akkari](https://www.linkedin.com/in/lea-akkari-640889103/)

Expand Down
29 changes: 29 additions & 0 deletions docs/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Concepts of Web Template Studio

This section outlines the main concepts and definitions used in Web Template Studio.

## Main concepts

Web Template Studio is divided in the following main elements:

- **Extension**: Refers to the Visual Studio Code Extension project, which, once installed, allows users to have an improved experience when creating a new Web Application from the "Web Template Studio: Launch" command. The extension is written in typescript.
- **Wizard**: Refers to the WebTS client project, where all user interaction occurs after launching Web Template Studio. The Wizard guides the user through some steps to create the desired project. It allows the user to select from the available frameworks, pages and Azure Cloud Services. The wizard is created with React Typescript and is displayed through the React Panel.
- **Core Template Studio and Core Template Studio CLI**: Refers to the .NET Core executable that handles all of the template synchronization and code generation (composition, generation + postaction execution). The CLI is the entry point for executing commands on Core Template Studio executable. CoreTS CLI is a self-contained .NET Core 3.1 application.
- **Template** - A template contains code with metadata. The metadata will contain the following template information: name, description, licensing, remarks, programming language, type, etc. The template definition is based on [dotnet Template Engine](https://github.com/dotnet/templating). [More details on templates](/contributing/templates.md)

## Other Terminology

- **WinTS/Windows Template Studio** - Refers to the Visual Studio extension used to generate boilerplate code for UWP applications.
- **Contributing Developer** - A developer who is contributing to this open source project.
- **User** - A developer who is using the WebTS extension.
- **MockUps** - A sample project that contains the code as it will be generated by the engine. MockUps are used to discuss how the generated code should look like before doing the templates.

---

## Learn more

- [Installing the extension](./install.md)
- [Application Arquitecture](./contributing/application-architecture.md)
- [Getting started with the WebTS codebase](./contributing/getting-started-developers.md)
- [Templates](./contributing/templates.md)
- [All docs](./readme.md)
Loading

0 comments on commit 13db8e3

Please sign in to comment.