Skip to content
This repository was archived by the owner on May 29, 2018. It is now read-only.

Repository files navigation

angular2-meteor-boilerplate V0.0.1

This boilerplate is here to give you a simple starting point for your Angular2-Meteor projects.

# Assuming Meteor and Typescript is already installed
git clone https://github.com/MichaelSolati/angular2-meteor-boilerplate.git
cd angular2-meteor-boilerplate
npm install
npm start

Folder Structure

.
├── client                                        # Client files
│   ├── index.html                                # First loaded view pulling from imports
│   └── main.ts                                   # Imports all required files - Bootstrap Angular 2 app
├── imports                                       # A client/server folder
│   └── app                                       #
│      ├── home                                   #
│      │  ├── home.component.html                 # Home page component HTML (CLIENT ONLY)
│      │  └── home.component.ts                   # Home page component Class (CLIENT ONLY)
│      ├── home-outlet                            #
│      │  ├── home-outlet.component.ts            # Outlet (HTML and Class) for all routed in "/" parent route (CLIENT ONLY)
│      │  └── home-outlet.routes.ts               # Defines all routes for "/" parent route (CLIENT ONLY)
│      ├── app.component.ts                       # App component (CLIENT ONLY)
│      ├── app.module.ts                          # App module (CLIENT ONLY)
│      └── app.routes.ts                          # Defines all routes for app (CLIENT ONLY)
├── private                                       # Assets only available to the Server
│   └── docs                                      # YuiDoc for project
├── typings                                       #
└── package.json                                  # node dependencies
├── README.md                                     # You are here
├── tsconfig.json                                 # Basic configurations to run an Angular 2.0 Meteor app
└── typings.json                                  #
└── yuidoc.json                                   # Settings for YuiDoc generation

Yuidoc (Documentation)

All documentation is available in the ./private/docs folder as created by Yuidoc.

In order to install and run Yuidoc to generate new updates docs install Yuidoc on your computer with npm -g install yuidocjs. There is also a npm run script that will generate docs with the preferred settings called npm run documentation.

Learn More

About

This boilerplate is here to give you a simple starting point for your Angular2-Meteor projects.

Resources

Stars

5 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages