diff --git a/CHANGELOG.md b/CHANGELOG.md index ccea3a9..46da4f9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,2 @@ -# 4.0.0 -* Changed to usage `angel3_` packages +# 1.0.0 +* Application template to build web application with `Angel3` framework \ No newline at end of file diff --git a/README.md b/README.md index 274cbdc..984ea95 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,12 @@ [![Angel 3 Framework](./logo3.png)] -[![version](https://img.shields.io/badge/pub-v4.0.0-brightgreen)](https://pub.dartlang.org/packages/framework) +[![version](https://img.shields.io/badge/pub-v4.0.0-brightgreen)](https://pub.dartlang.org/packages/angel3_framework) [![Null Safety](https://img.shields.io/badge/null-safety-brightgreen)](https://dart.dev/null-safety) [![Gitter](https://img.shields.io/gitter/room/nwjs/nw.js.svg)](https://gitter.im/angel_dart/discussion) [![License](https://img.shields.io/github/license/dukefirehawk/angel)](https://github.com/dukefirehawk/angel/LICENSE) - **A polished, production-ready backend framework in Dart.** @@ -29,25 +21,25 @@ out-of-the-box in a consistent manner. ## Installation & Setup -1. Download and install [Dart](https://www.dartlang.org/). +1. Download and install [Dart](https://dart.dev/get-dart). 2. Run the following command to start Angel3 server in dev mode to *hot-reloaded* on file changes: ```bash dart --observe bin/dev.dart ``` -3. Next, check out the [detailed documentation](https://docs.angel-dart.dev/v/2.x) to learn to flesh out your project. Angel3 works the same way as the original Angel. +3. Next, check out the [detailed documentation](https://angel3-docs.dukefirehawk.com/guides) to learn to flesh out your project. Angel3 works the same way as the original Angel. ## Examples and Documentation -Visit the [documentation](https://docs.angel-dart.dev/v/2.x) +Visit the [documentation](https://angel3-docs.dukefirehawk.com/guides) for dozens of guides and resources, including video tutorials, to get up and running as quickly as possible with Angel. Examples and complete projects can be found -[here](https://github.com/angel-dart/examples-v2). +[here](https://github.com/dukefirehawk/angel3-examples). -You can also view the [API Documentation](http://www.dartdocs.org/documentation/angel_framework/latest). +You can also view the [API Documentation](https://pub.dev/documentation/angel3_framework/latest/). -There is also an [Awesome Angel :fire:](https://github.com/angel-dart/awesome-angel) list. +There is also an [Awesome Angel :fire:](https://github.com/dukefirehawk/angel3-awesome) list. diff --git a/bin/dev.dart b/bin/dev.dart index 549be3a..3c7ede3 100644 --- a/bin/dev.dart +++ b/bin/dev.dart @@ -4,7 +4,7 @@ import 'package:angel3_pretty_logging/angel3_pretty_logging.dart'; import 'package:angel3_container/mirrors.dart'; import 'package:angel3_framework/angel3_framework.dart'; import 'package:angel3_hot/angel3_hot.dart'; -import 'package:myapp/myapp.dart'; +import 'package:angel3_basic/angel.dart'; void main() async { // Watch the config/ and web/ directories for changes, and hot-reload the server. diff --git a/bin/prod.dart b/bin/prod.dart index 827768a..7386c51 100644 --- a/bin/prod.dart +++ b/bin/prod.dart @@ -1,6 +1,6 @@ import 'package:angel3_container/mirrors.dart'; import 'package:angel3_production/angel3_production.dart'; -import 'package:myapp/myapp.dart'; +import 'package:angel3_basic/angel.dart'; // NOTE: By default, the Runner class does not use the `MirrorsReflector`, or any // reflector, by default. diff --git a/lib/myapp.dart b/lib/angel.dart similarity index 98% rename from lib/myapp.dart rename to lib/angel.dart index a3a46b4..59d8bde 100644 --- a/lib/myapp.dart +++ b/lib/angel.dart @@ -1,5 +1,5 @@ /// Your very own web application! -library myapp; +library angel; import 'dart:async'; import 'package:angel3_framework/angel3_framework.dart'; diff --git a/lib/src/config/config.dart b/lib/src/config/config.dart index 9e1325e..6aeb9e8 100644 --- a/lib/src/config/config.dart +++ b/lib/src/config/config.dart @@ -1,5 +1,5 @@ /// Configuration for this Angel instance. -library myapp.src.config; +library angel.src.config; import 'package:angel3_configuration/angel3_configuration.dart'; import 'package:angel3_framework/angel3_framework.dart'; diff --git a/lib/src/config/plugins/plugins.dart b/lib/src/config/plugins/plugins.dart index f68683b..d45466c 100644 --- a/lib/src/config/plugins/plugins.dart +++ b/lib/src/config/plugins/plugins.dart @@ -1,5 +1,5 @@ /// Custom plugins go here. -library myapp.src.config.plugins; +library angel.src.config.plugins; import 'dart:async'; import 'package:angel3_framework/angel3_framework.dart'; diff --git a/lib/src/routes/controllers/controllers.dart b/lib/src/routes/controllers/controllers.dart index 67ad6cd..e55e239 100644 --- a/lib/src/routes/controllers/controllers.dart +++ b/lib/src/routes/controllers/controllers.dart @@ -1,4 +1,4 @@ -library myapp.src.routes.controllers; +library angel.src.routes.controllers; import 'dart:async'; import 'package:angel3_framework/angel3_framework.dart'; diff --git a/lib/src/routes/routes.dart b/lib/src/routes/routes.dart index 4c7c9c0..6a3feb9 100644 --- a/lib/src/routes/routes.dart +++ b/lib/src/routes/routes.dart @@ -1,5 +1,5 @@ /// This app's route configuration. -library myapp.src.routes; +library angel.src.routes; import 'package:angel3_framework/angel3_framework.dart'; import 'package:angel3_static/angel3_static.dart'; diff --git a/logo3.png b/logo3.png new file mode 100644 index 0000000..2f0202a Binary files /dev/null and b/logo3.png differ diff --git a/pubspec.yaml b/pubspec.yaml index e1ddcfd..a8870fc 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,8 @@ -name: myapp -version: 4.0.0 -description: An app that's going to be amazing pretty soon. +name: angel3_basic +version: 1.0.0 +description: A boilerplate template for building Angel3 application publish_to: none # Ensure we don't accidentally publish our private code! ;) -homepage: https://github.com/dukefirehawk/angel +homepage: https://github.com/dukefirehawk/boilerplates environment: sdk: '>=2.12.0 <3.0.0' dependencies: diff --git a/test/all_test.dart b/test/all_test.dart index 42ede8f..5638f35 100644 --- a/test/all_test.dart +++ b/test/all_test.dart @@ -1,7 +1,7 @@ import 'package:angel3_framework/angel3_framework.dart'; import 'package:angel3_test/angel3_test.dart'; import 'package:test/test.dart'; -import 'package:myapp/myapp.dart'; +import 'package:angel3_basic/angel.dart'; // Angel also includes facilities to make testing easier. //