From 99554ac99b905013d0412c37b474bc3b59288d59 Mon Sep 17 00:00:00 2001 From: Anthony Verez Date: Sat, 30 May 2020 18:41:08 +0200 Subject: [PATCH] Link to packages in monorepo --- .gitignore | 1 + SUMMARY.md | 68 +++++++++++++++++----------------- guides/README.md | 6 +-- guides/basic-routing.md | 2 +- guides/cli.md | 2 +- guides/dependency-injection.md | 2 +- guides/rendering-views.md | 6 +-- guides/service-basics.md | 4 +- guides/testing.md | 6 +-- orm/about.md | 2 +- orm/basic-functionality.md | 2 +- orm/migrations.md | 4 -- 12 files changed, 52 insertions(+), 53 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..485dee6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea diff --git a/SUMMARY.md b/SUMMARY.md index 1b4b16f..854a023 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,6 +1,6 @@ * Migration from Angel 1.1.x * [Rationale - Why a new Version?](migration/rationale.md) - * [Framework Changelog](https://github.com/angel-dart/framework/blob/master/CHANGELOG.md) + * [Framework Changelog](https://github.com/angel-dart/angel/blob/master/packages/framework/CHANGELOG.md) * [2.0.0 Migration Guide](migration/migration-guide.md) * ORM * [About](orm/about.md) @@ -25,7 +25,7 @@ * [Using Plug-ins](guides/using-plug-ins.md) * [Rendering Views](guides/rendering-views.md) * [Service Basics](guides/service-basics.md) - * [REST Client](https://github.com/angel-dart/client) + * [REST Client](https://github.com/angel-dart/angel/tree/master/packages/client) * [Testing](guides/testing.md) * [Error Handling](guides/error-handling.md) * [Pattern Matching and `Parameter`](guides/pattern-matching.md) @@ -35,28 +35,28 @@ * [YouTube Tutorials](https://www.youtube.com/playlist?list=PLl3P3tmiT-fqGCB2vSPq8HhpugEDNWUo6) * [Ecosystem](https://github.com/angel-dart/awesome-angel) * Packages - * [Authentication](https://github.com/angel-dart/auth) - * [Local](https://github.com/angel-dart/auth/wiki/Local-Auth) - * [Twitter SSO](https://github.com/angel-dart/auth_twitter) - * [OAuth2 \(generic\)](https://github.com/angel-dart/auth_oauth2) - * [OAuth2 server implementation](https://github.com/angel-dart/oauth2) - * [CORS](https://github.com/angel-dart/cors) - * [Database-Agnostic Relations](https://github.com/angel-dart/relations) - * [Configuration](https://github.com/angel-dart/configuration) + * [Authentication](https://github.com/angel-dart/angel/tree/master/packages/auth) + * [Local](https://pub.dev/documentation/angel_auth/latest/angel_auth/LocalAuthStrategy-class.html) + * [Twitter SSO](https://github.com/angel-dart/angel/tree/master/packages/auth_twitter) + * [OAuth2 \(generic\)](https://github.com/angel-dart/angel/tree/master/packages/auth_oauth2) + * [OAuth2 server implementation](https://github.com/angel-dart/angel/tree/master/packages/oauth2) + * [CORS](https://github.com/angel-dart/angel/tree/master/packages/cors) + * [Database-Agnostic Relations](https://github.com/angel-dart/angel/tree/master/packages/relations) + * [Configuration](https://github.com/angel-dart/angel/tree/master/packages/configuration) * Database Adapters - * [MongoDB](https://github.com/angel-dart/mongo) - * [RethinkDB](https://github.com/angel-dart/rethink) - * [JSON File-based](https://github.com/angel-dart/file_service) - * [ORM](https://github.com/angel-dart/orm) + * [MongoDB](https://github.com/angel-dart/angel/tree/master/packages/mongo) + * [RethinkDB](https://github.com/angel-dart/angel/tree/master/packages/rethink) + * [JSON File-based](https://github.com/angel-dart/angel/tree/master/packages/file_service) + * [ORM](https://github.com/angel-dart/angel/tree/master/packages/orm) * [Basic Functionality](orm/basic-functionality.md) * [Relations](orm/relations.md) * [NoSQL](orm/nosql.md) * [PostgreSQL](orm/postgresql.md) * [Migrations](orm/migrations.md) * Front-end - * [Mustache Templates](https://github.com/angel-dart/mustache) + * [Mustache Templates](https://github.com/angel-dart/angel/tree/master/packages/mustache) * [Jael template engine](front-end/jael/README.md) - * [Github](https://github.com/angel-dart/jael) + * [Github](https://github.com/angel-dart/angel/tree/master/packages/jael) * [Basics](front-end/jael/Basics.md) * [Custom Elements](front-end/jael/Custom-Elements.md) * [Strict Resolution](front-end/jael/Strict-Resolution.md) @@ -66,24 +66,26 @@ * [Directive: `if`](front-end/jael/Directive:-if.md) * [Directive: `include`](front-end/jael/Directive:-include.md) * [Directive: `switch`](front-end/jael/Directive:-switch.md) + * [Jinja Templates](https://github.com/angel-dart/angel/tree/master/packages/jinja) * [`compiled_mustache`-based engine](https://github.com/thislooksfun/angel_compiled_mustache) - * [`html_builder`-based engine](https://github.com/angel-dart/html) - * [Markdown template engine](https://github.com/angel-dart/markdown) + * [`html_builder`-based engine](https://github.com/angel-dart/angel/tree/master/packages/html) + * [Markdown template engine](https://github.com/angel-dart/angel/tree/master/packages/markdown) * [Using Angel with Angular](https://dart.academy/using-angel-with-angular2/) - * [Hot Reloading](https://github.com/angel-dart/hot) - * [Pagination](https://github.com/angel-dart/paginate) - * [Polling](https://github.com/angel-dart/poll) - * [Production Utilities](https://github.com/angel-dart/production) - * [Reverse Proxy](https://github.com/angel-dart/proxy) - * [Router](https://github.com/angel-dart/route) - * [Serialization](https://github.com/angel-dart/serialize) + * [Hot Reloading](https://github.com/angel-dart/angel/tree/master/packages/hot) + * [Pagination](https://github.com/angel-dart/angel/tree/master/packages/paginate) + * [Polling](https://github.com/angel-dart/angel/tree/master/packages/poll) + * [Production Utilities](https://github.com/angel-dart/angel/tree/master/packages/production) + * [Reverse Proxy](https://github.com/angel-dart/angel/tree/master/packages/proxy) + * [Router](https://github.com/angel-dart/angel/tree/master/packages/route) + * [Serialization](https://github.com/angel-dart/angel/tree/master/packages/serialize) * [Service Seeder](https://github.com/angel-dart/seeder) - * [Static Files](https://github.com/angel-dart/static)(https://github.com/angel-dart/sync) - * [Security](https://github.com/angel-dart/security) - * [Server-sent Events](https://github.com/angel-dart/eventsource) - * [`shelf` Integration](https://github.com/angel-dart/shelf) + * [Static Files](https://github.com/angel-dart/angel/tree/master/packages/static) + * [Sync](https://github.com/angel-dart/angel/tree/master/packages/sync) + * [Security](https://github.com/angel-dart/angel/tree/master/packages/security) + * [Server-sent Events](https://github.com/angel-dart/angel/tree/master/packages/eventsource) + * [`shelf` Integration](https://github.com/angel-dart/angel/tree/master/packages/shelf) * [Task Engine](https://github.com/angel-dart/task) - * [User Agents](https://github.com/angel-dart/user_agent) - * [Validation](https://github.com/angel-dart/validate) - * [Websockets](https://github.com/angel-dart/websocket) - * [WebSocket synchronization via `pub_sub`](https://github.com/angel-dart/sync) + * [User Agents](https://github.com/angel-dart/angel/tree/master/packages/user_agent) + * [Validation](https://github.com/angel-dart/angel/tree/master/packages/validate) + * [Websockets](https://github.com/angel-dart/angel/tree/master/packages/websocket) + * [WebSocket synchronization via `pub_sub`](https://github.com/angel-dart/angel/tree/master/packages/sync) diff --git a/guides/README.md b/guides/README.md index ccf202b..4e21f44 100644 --- a/guides/README.md +++ b/guides/README.md @@ -11,8 +11,8 @@ * [Legacy Tutorial](https://medium.com/@thosakwe/building-a-simple-file-upload-app-with-angel-64938d4ddc61) * [Using Plug-ins](using-plug-ins.md) * [Rendering Views](rendering-views.md) -* [REST Client](https://github.com/angel-dart/client) -* [Testing](https://github.com/angel-dart/gitbook/tree/b0cc75e0fd287d121f47c7c80c221c69640a37b3/the-basics/testing.md) +* [REST Client](https://github.com/angel-dart/angel/tree/master/packages/client) +* [Testing](testing.md) * [Error Handling](error-handling.md) -* [Command Line](https://github.com/angel-dart/cli) +* [Command Line](https://github.com/angel-dart/angel/tree/master/packages/cli) diff --git a/guides/basic-routing.md b/guides/basic-routing.md index 0156cc8..c630349 100644 --- a/guides/basic-routing.md +++ b/guides/basic-routing.md @@ -100,7 +100,7 @@ app.group('/user/:id', (router) { ## Extended Documentation -For more documentation on the router, see [its repository](https://github.com/angel-dart/route). [`package:angel_route`](https://pub.dartlang.org/packages/angel_route) has no `dart:io` or `dart:mirrors` dependency, and it also supports browser use \(both hash and push state\). +For more documentation on the router, see [its folder](https://github.com/angel-dart/angel/tree/master/packages/route). [`package:angel_route`](https://pub.dartlang.org/packages/angel_route) has no `dart:io` or `dart:mirrors` dependency, and it also supports browser use \(both hash and push state\). ## Next Up... diff --git a/guides/cli.md b/guides/cli.md index 2ba23e6..0423ace 100644 --- a/guides/cli.md +++ b/guides/cli.md @@ -1,6 +1,6 @@ # Angel CLI -The [Angel CLI](https://github.com/angel-dart/cli) is a friendly +The [Angel CLI](https://github.com/angel-dart/angel/tree/master/packages/cli) is a friendly command line tool enabling quick scaffolding of common project constructs. diff --git a/guides/dependency-injection.md b/guides/dependency-injection.md index a028268..229b51f 100644 --- a/guides/dependency-injection.md +++ b/guides/dependency-injection.md @@ -1,6 +1,6 @@ # Dependency-Injection -Angel uses a [container hierarchy](https://github.com/angel-dart/container) for DI. +Angel uses a [container hierarchy](https://github.com/angel-dart/angel/tree/master/packages/container) for DI. Dependency injection makes it easier to build applications with multiple moving parts, because logic can be contained in one location and reused at another place in your application. ## Adding a Singleton diff --git a/guides/rendering-views.md b/guides/rendering-views.md index e4d5140..83e3cf5 100644 --- a/guides/rendering-views.md +++ b/guides/rendering-views.md @@ -9,9 +9,9 @@ Just like `res.render` in Express, Angel's `ResponseContext` exposes a `Future` called `render`. This invokes whichever function is assigned to your server's `viewGenerator`. -There is a Mustache templating plug-in for Angel available: [https://github.com/angel-dart/mustache](https://github.com/angel-dart/mustache) +There is a Mustache templating plug-in for Angel available: [https://github.com/angel-dart/angel/tree/master/packages/mustache](https://github.com/angel-dart/angel/tree/master/packages/mustache) -There is also [Jael](https://github.com/angel-dart/jael), one of the few actively-developed HTML templating engines for Dart. +There is also [Jael](https://github.com/angel-dart/angel/tree/master/packages/jael), one of the few actively-developed HTML templating engines for Dart. Angel support for Jael is provided through [`package:angel_jael`](https://pub.dartlang.org/packages/angel_jael). @@ -57,6 +57,6 @@ main() async { ## Next Up... -1. Explore Angel's isomorphic [client library](https://github.com/angel-dart/client). +1. Explore Angel's isomorphic [client library](https://github.com/angel-dart/angel/tree/master/packages/client). 2. Find out how to [test Angel applications](testing.md). diff --git a/guides/service-basics.md b/guides/service-basics.md index 67b69cf..400dcf6 100644 --- a/guides/service-basics.md +++ b/guides/service-basics.md @@ -7,7 +7,7 @@ One of the main concepts within Angel, which is borrowed from FeathersJS, is a _service_. You more than likely have already dealt with another implementation of the service concept. In Angel, a _service_ is a class that acts as a Web interface and exposes CRUD actions operating on a set of data. Angel services extend `Routable`, and thus can be mounted on a certain path and become REST endpoints. -The Angel core library includes the `Service` base class, as well as two in-memory service classes. Database adapter packages, such as [`package:angel_mongo`](https://github.com/angel-dart/mongo) include service classes that let you interact with a database without writing complex code yourself. +The Angel core library includes the `Service` base class, as well as two in-memory service classes. Database adapter packages, such as [`package:angel_mongo`](https://github.com/angel-dart/angel/tree/master/packages/mongo) include service classes that let you interact with a database without writing complex code yourself. Services can also be filtered or reacted to with [service hooks](hooks.md). @@ -113,7 +113,7 @@ var service = app.service>('secret'); ## Additional Notes Important things to consider when writing your own service: -* [mongo](https://github.com/angel-dart/mongo/blob/master/lib/mongo_service.dart) is a good reference implementation] +* [mongo](https://github.com/angel-dart/angel/tree/master/packages/mongo/lib/mongo_service.dart) is a good reference implementation] * Services need only worry about handling `Map`s. Object serialization should be handled by `angel_serialize`, another serializer, or `TypedService`. * Allowing users to query the service via query string is optional (see `allowQuery`) * Allowing users to remove all entries is **optional**, and should be disabled by default diff --git a/guides/testing.md b/guides/testing.md index 33d7bde..795f5dc 100644 --- a/guides/testing.md +++ b/guides/testing.md @@ -9,13 +9,13 @@ ## Testing -Dart already has fantastic testing support, through a library of [testing helpers](https://github.com/angel-dart/test) that will make test writing faster. The following functions are exported by [`package:angel_test`](https://github.com/angel-dart/test), and will make your testing much easier. +Dart already has fantastic testing support, through a library of [testing helpers](https://github.com/angel-dart/angel/tree/master/packages/test) that will make test writing faster. The following functions are exported by [`package:angel_test`](https://github.com/angel-dart/angel/tree/master/packages/test), and will make your testing much easier. ### connectTo [Full definition](https://www.dartdocs.org/documentation/angel_test/latest/angel_test/connectTo.html) -This function will start `app` on an available port, and return a `TestClient` instance \(based on [`package:angel_client`](https://github.com/angel-dart/client)\) configured to send requests to the server. The client also supports session manipulation. +This function will start `app` on an available port, and return a `TestClient` instance \(based on [`package:angel_client`](https://github.com/angel-dart/angel/tree/master/packages/client) configured to send requests to the server. The client also supports session manipulation. ```dart main() { @@ -51,5 +51,5 @@ The complete set of `angel_test` Matchers can be found [here](https://www.dartdo ## Next Up... 1. Find out how to [handle errors](error-handling.md) in an Angel application. -2. Learn how to use the handy [Angel CLI](https://github.com/angel-dart/cli). +2. Learn how to use the handy [Angel CLI](https://github.com/angel-dart/angel/tree/master/packages/cli). diff --git a/orm/about.md b/orm/about.md index e362536..b34b0e7 100644 --- a/orm/about.md +++ b/orm/about.md @@ -55,4 +55,4 @@ guides, rather than technical documentation. For more in-depth documentation, see the actual `angel_orm` project on Github: -https://github.com/angel-dart/orm \ No newline at end of file +https://github.com/angel-dart/angel/tree/master/packages/orm \ No newline at end of file diff --git a/orm/basic-functionality.md b/orm/basic-functionality.md index cacc34f..8d2a285 100644 --- a/orm/basic-functionality.md +++ b/orm/basic-functionality.md @@ -1,7 +1,7 @@ Before starting with the ORM, it is highly recommended to familiar one's self with `package:angel_serialize`, as it is the foundation for `package:angel_orm`: -https://github.com/angel-dart/serialize +https://github.com/angel-dart/angel/tree/master/packages/serialize To enable the ORM for a given model, simply add the `@orm` annotation to its definition: diff --git a/orm/migrations.md b/orm/migrations.md index e0d4014..91330be 100644 --- a/orm/migrations.md +++ b/orm/migrations.md @@ -25,10 +25,6 @@ class UserMigration implements Migration { Migrations can be used to either create, alter, or drop database tables. -For more in-depth documentation, consult the `angel_migration` documentation: - -https://github.com/angel-dart/migration - If you use `angel_orm_generator`, then a migration will be generated by default for each class annotated with `@orm`.