diff --git a/.idea/angel.iml b/.idea/angel.iml deleted file mode 100644 index eae1301..0000000 --- a/.idea/angel.iml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml deleted file mode 100644 index c65900a..0000000 --- a/.idea/misc.xml +++ /dev/null @@ -1,28 +0,0 @@ - - - - - - - - - - - - - General - - - XPath - - - - - AngularJS - - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index b034384..0000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/runConfigurations/dev_dart.xml b/.idea/runConfigurations/dev_dart.xml deleted file mode 100644 index 418187f..0000000 --- a/.idea/runConfigurations/dev_dart.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/runConfigurations/prod_dart.xml b/.idea/runConfigurations/prod_dart.xml deleted file mode 100644 index e93c56a..0000000 --- a/.idea/runConfigurations/prod_dart.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 46da4f9..a750059 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,6 @@ -# 1.0.0 -* Application template to build web application with `Angel3` framework \ No newline at end of file +# Change Log + +## 1.0.0 + +* Changed to use `angel3` packages +* Updated to support NNBD diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be2f075..528e381 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,25 @@ -# Contributing Angel3 -Any contributions from the community are welcome. +# Contribution + +Any help from the open-source community is always welcome and needed: + +1. Found an issue? + - Please [fill a bug report][tracker] with error message and steps to reproduce it. +2. Wish a feature? + - Open a feature request with use cases. +3. Are you using and liking the project? + - Create an article about your use case + - Do a post on your likes and dislikes + - Make a donation. +4. Are you a developer? + - Fix a bug and send a [pull request][pull_request] + - Implement a new feature + - Improve the Unit Tests + - Improve the [User Guide][doc] and send a [document pull request][doc_repo] +5. Have you already helped in any way? + - **Many thanks to the contributors and everybody that uses this project!** + +[tracker]: https://github.com/dukefirehawk/angel/issues +[pull_request]: https://github.com/dukefirehawk/angel/pulls +[doc]: https://angel3-docs.dukefirehawk.com +[doc_repo]: https://github.com/dukefirehawk/angel3-guide/pulls diff --git a/README.md b/README.md index 753b2d7..6f5e7d5 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,38 @@ -## Angel 3 Boilerplates +# Basic Starter Application for Angel3 framework -[![Angel 3 Framework](./logo3.png)](https://github.com/dukefirehawk/angel) - - -[![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/boilerplates/LICENSE) - - -**A polished, null-safety, production-ready backend framework in Dart.** - -*Note: This repo is an application boilerplate ,and not the underlying framework library.* - ------ -## About -Angel3 is a full-stack Web framework in Dart. It aims to streamline development by providing many common features out-of-the-box in a consistent manner. - -**Forked from Angel framework to support NNBD** +This is a basic starter application for [Angel3 framework](https://pub.dartlang.org/packages/angel3_framework) which is a full-stack Web framework in Dart. ## Installation & Setup 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 -``` +### Development -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. +1. Run the following command to start Angel3 server in dev mode to *hot-reloaded* on file changes: -## Examples and Documentation -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. + ```bash + dart --observe bin/dev.dart + ``` -Examples and complete projects can be found -[here](https://github.com/dukefirehawk/angel3-examples). +2. Modify the code and watch the changes applied to the application +### Production + +1. Run the following command: + + ```bash + dart bin/prod.dart + ``` + +2. Run as docker. Edit and run the provided `Dockerfile` to build the image. + +## Resources + +Visit the [Developer Guide](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 Angel3. + +Examples and complete projects can be found [here](https://github.com/dukefirehawk/angel3-examples). You can also view the [API Documentation](https://pub.dev/documentation/angel3_framework/latest/). There is also an [Awesome Angel :fire:](https://github.com/dukefirehawk/angel3-awesome) list. - diff --git a/analysis_options.yaml b/analysis_options.yaml index 2981164..a4f3335 100644 --- a/analysis_options.yaml +++ b/analysis_options.yaml @@ -2,7 +2,3 @@ include: package:pedantic/analysis_options.yaml analyzer: strong-mode: implicit-casts: false -linter: - rules: - - unnecessary_const - - unnecessary_new diff --git a/lib/angel.dart b/lib/angel.dart index 59d8bde..baaf97c 100644 --- a/lib/angel.dart +++ b/lib/angel.dart @@ -1,6 +1,4 @@ /// Your very own web application! -library angel; - import 'dart:async'; import 'package:angel3_framework/angel3_framework.dart'; import 'package:file/local.dart'; diff --git a/lib/src/config/config.dart b/lib/src/config/config.dart index 6aeb9e8..9e5e931 100644 --- a/lib/src/config/config.dart +++ b/lib/src/config/config.dart @@ -1,6 +1,4 @@ /// Configuration for this Angel instance. -library angel.src.config; - import 'package:angel3_configuration/angel3_configuration.dart'; import 'package:angel3_framework/angel3_framework.dart'; import 'package:angel3_jael/angel3_jael.dart'; diff --git a/lib/src/config/plugins/plugins.dart b/lib/src/config/plugins/plugins.dart index d45466c..06a5e30 100644 --- a/lib/src/config/plugins/plugins.dart +++ b/lib/src/config/plugins/plugins.dart @@ -1,6 +1,4 @@ /// Custom plugins go here. -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 e55e239..1942aaf 100644 --- a/lib/src/routes/controllers/controllers.dart +++ b/lib/src/routes/controllers/controllers.dart @@ -1,5 +1,3 @@ -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 6a3feb9..b428f4e 100644 --- a/lib/src/routes/routes.dart +++ b/lib/src/routes/routes.dart @@ -1,6 +1,4 @@ /// This app's route configuration. -library angel.src.routes; - import 'package:angel3_framework/angel3_framework.dart'; import 'package:angel3_static/angel3_static.dart'; import 'package:file/file.dart'; diff --git a/lib/src/services/services.dart b/lib/src/services/services.dart index 02d2d28..188d0b8 100644 --- a/lib/src/services/services.dart +++ b/lib/src/services/services.dart @@ -1,6 +1,4 @@ /// Declare services here! -library myapp.services; - import 'dart:async'; import 'package:angel3_framework/angel3_framework.dart'; diff --git a/logo3.png b/logo3.png deleted file mode 100644 index 2f0202a..0000000 Binary files a/logo3.png and /dev/null differ diff --git a/pubspec.yaml b/pubspec.yaml index 1866e03..22e6498 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,8 +1,7 @@ name: angel version: 1.0.0 -description: A boilerplate template for building Angel3 application +description: A basic starter application for Angel3 framework publish_to: none -homepage: https://github.com/dukefirehawk/boilerplates environment: sdk: '>=2.12.0 <3.0.0' dependencies: