Community Schematics
Angular Schematics that generate a starter website for community groups.
ng deploy
support to deploy your site to Azure, Now, Netlify, or Github Pages
Getting Started
First generate a new Angular project:
$ ng new my-community-site
Then use ng add
and follow the prompts to setup the project and you're good to go!
$ ng add @ng-seattle/community-schematics
External Schematics Used
Depending on the options you select during the ng add
process, the following external ng add
schematics can be invoked:
- @angular/material (This is always invoked)
- @azure/ng-deploy
- angular-cli-ghpages
- @netlify-builder/deploy
- @zeit/ng-deploy
- @schuchard/prettier
Future Feature Plans
- [ ] Easy (and private) contact sharing to help network with people you meet at group events
- [ ] PWA and Angular Universal support
- [ ] Self hosted blogs for groups
- [ ] Calendar management without Meetup.com
- [ ] Email list support
- Have an idea? Open an issue!
Developing
This project comes with a sandbox Angular application that you can use to test your changes with. Before starting development run npm run link:schematic
to ensure that your local schematic can be used in the sandbox.
Testing
To test locally, install @angular-devkit/schematics-cli
globally and use the schematics
command line tool. That tool acts the same as the generate
command of the Angular CLI, but also has a debug mode. For convienience, there is a script that will clean the project, build it, and run the command line argouments to test. Simply run npm test
to exectute.
Check the documentation with
schematics --help
Publishing
To publish, simply do:
npm run build
npm publish
That's it!