Updated basic
This commit is contained in:
parent
89dde22a52
commit
be518fa3c0
17 changed files with 54 additions and 123 deletions
|
@ -1,16 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<module type="WEB_MODULE" version="4">
|
|
||||||
<component name="NewModuleRootManager">
|
|
||||||
<content url="file://$MODULE_DIR$">
|
|
||||||
<excludeFolder url="file://$MODULE_DIR$/.pub" />
|
|
||||||
<excludeFolder url="file://$MODULE_DIR$/.tmp" />
|
|
||||||
<excludeFolder url="file://$MODULE_DIR$/build" />
|
|
||||||
<excludeFolder url="file://$MODULE_DIR$/temp" />
|
|
||||||
<excludeFolder url="file://$MODULE_DIR$/tmp" />
|
|
||||||
</content>
|
|
||||||
<orderEntry type="inheritedJdk" />
|
|
||||||
<orderEntry type="sourceFolder" forTests="false" />
|
|
||||||
<orderEntry type="library" name="Dart SDK" level="project" />
|
|
||||||
<orderEntry type="library" name="Dart Packages" level="project" />
|
|
||||||
</component>
|
|
||||||
</module>
|
|
|
@ -1,28 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project version="4">
|
|
||||||
<component name="JavaScriptSettings">
|
|
||||||
<option name="languageLevel" value="ES6" />
|
|
||||||
</component>
|
|
||||||
<component name="ProjectInspectionProfilesVisibleTreeState">
|
|
||||||
<entry key="Project Default">
|
|
||||||
<profile-state>
|
|
||||||
<expanded-state>
|
|
||||||
<State>
|
|
||||||
<id />
|
|
||||||
</State>
|
|
||||||
<State>
|
|
||||||
<id>General</id>
|
|
||||||
</State>
|
|
||||||
<State>
|
|
||||||
<id>XPath</id>
|
|
||||||
</State>
|
|
||||||
</expanded-state>
|
|
||||||
<selected-state>
|
|
||||||
<State>
|
|
||||||
<id>AngularJS</id>
|
|
||||||
</State>
|
|
||||||
</selected-state>
|
|
||||||
</profile-state>
|
|
||||||
</entry>
|
|
||||||
</component>
|
|
||||||
</project>
|
|
|
@ -1,8 +0,0 @@
|
||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project version="4">
|
|
||||||
<component name="ProjectModuleManager">
|
|
||||||
<modules>
|
|
||||||
<module fileurl="file://$PROJECT_DIR$/.idea/angel.iml" filepath="$PROJECT_DIR$/.idea/angel.iml" />
|
|
||||||
</modules>
|
|
||||||
</component>
|
|
||||||
</project>
|
|
|
@ -1,8 +0,0 @@
|
||||||
<component name="ProjectRunConfigurationManager">
|
|
||||||
<configuration default="false" name="dev.dart" type="DartCommandLineRunConfigurationType" factoryName="Dart Command Line Application" singleton="true" nameIsGenerated="true">
|
|
||||||
<option name="VMOptions" value="--observe" />
|
|
||||||
<option name="filePath" value="$PROJECT_DIR$/bin/dev.dart" />
|
|
||||||
<option name="workingDirectory" value="$PROJECT_DIR$" />
|
|
||||||
<method />
|
|
||||||
</configuration>
|
|
||||||
</component>
|
|
|
@ -1,11 +0,0 @@
|
||||||
<component name="ProjectRunConfigurationManager">
|
|
||||||
<configuration default="false" name="prod.dart" type="DartCommandLineRunConfigurationType" factoryName="Dart Command Line Application" singleton="true" nameIsGenerated="true">
|
|
||||||
<option name="checkedMode" value="false" />
|
|
||||||
<option name="envs">
|
|
||||||
<entry key="ANGEL_ENV" value="production" />
|
|
||||||
</option>
|
|
||||||
<option name="filePath" value="$PROJECT_DIR$/bin/prod.dart" />
|
|
||||||
<option name="workingDirectory" value="$PROJECT_DIR$" />
|
|
||||||
<method />
|
|
||||||
</configuration>
|
|
||||||
</component>
|
|
|
@ -1,2 +1,6 @@
|
||||||
# 1.0.0
|
# Change Log
|
||||||
* Application template to build web application with `Angel3` framework
|
|
||||||
|
## 1.0.0
|
||||||
|
|
||||||
|
* Changed to use `angel3` packages
|
||||||
|
* Updated to support NNBD
|
||||||
|
|
|
@ -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
|
||||||
|
|
53
README.md
53
README.md
|
@ -1,45 +1,38 @@
|
||||||
|
|
||||||
[![Angel 3 Framework](./logo3.png)](https://github.com/dukefirehawk/angel)
|
# Basic Starter Application for Angel3 framework
|
||||||
|
|
||||||
|
This is a basic start application for [Angel3 framework](https://pub.dartlang.org/packages/angel3_framework) which is a full-stack Web framework in Dart.
|
||||||
[![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.**
|
|
||||||
|
|
||||||
*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.
|
|
||||||
|
|
||||||
## Installation & Setup
|
## Installation & Setup
|
||||||
|
|
||||||
1. Download and install [Dart](https://dart.dev/get-dart).
|
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
|
### Development
|
||||||
dart --observe bin/dev.dart
|
|
||||||
```
|
|
||||||
|
|
||||||
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
|
```bash
|
||||||
Visit the [documentation](https://angel3-docs.dukefirehawk.com/guides)
|
dart --observe bin/dev.dart
|
||||||
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
|
2. Modify the code and watch the changes applied to the application
|
||||||
[here](https://github.com/dukefirehawk/angel3-examples).
|
|
||||||
|
|
||||||
|
### 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/).
|
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.
|
There is also an [Awesome Angel :fire:](https://github.com/dukefirehawk/angel3-awesome) list.
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,3 @@ include: package:pedantic/analysis_options.yaml
|
||||||
analyzer:
|
analyzer:
|
||||||
strong-mode:
|
strong-mode:
|
||||||
implicit-casts: false
|
implicit-casts: false
|
||||||
linter:
|
|
||||||
rules:
|
|
||||||
- unnecessary_const
|
|
||||||
- unnecessary_new
|
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
/// Your very own web application!
|
/// Your very own web application!
|
||||||
library angel;
|
|
||||||
|
|
||||||
import 'dart:async';
|
import 'dart:async';
|
||||||
import 'package:angel3_framework/angel3_framework.dart';
|
import 'package:angel3_framework/angel3_framework.dart';
|
||||||
import 'package:file/local.dart';
|
import 'package:file/local.dart';
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
/// Configuration for this Angel instance.
|
/// Configuration for this Angel instance.
|
||||||
library angel.src.config;
|
|
||||||
|
|
||||||
import 'package:angel3_configuration/angel3_configuration.dart';
|
import 'package:angel3_configuration/angel3_configuration.dart';
|
||||||
import 'package:angel3_framework/angel3_framework.dart';
|
import 'package:angel3_framework/angel3_framework.dart';
|
||||||
import 'package:angel3_jael/angel3_jael.dart';
|
import 'package:angel3_jael/angel3_jael.dart';
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
/// Custom plugins go here.
|
/// Custom plugins go here.
|
||||||
library angel.src.config.plugins;
|
|
||||||
|
|
||||||
import 'dart:async';
|
import 'dart:async';
|
||||||
import 'package:angel3_framework/angel3_framework.dart';
|
import 'package:angel3_framework/angel3_framework.dart';
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,3 @@
|
||||||
library angel.src.routes.controllers;
|
|
||||||
|
|
||||||
import 'dart:async';
|
import 'dart:async';
|
||||||
import 'package:angel3_framework/angel3_framework.dart';
|
import 'package:angel3_framework/angel3_framework.dart';
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
/// This app's route configuration.
|
/// This app's route configuration.
|
||||||
library angel.src.routes;
|
|
||||||
|
|
||||||
import 'package:angel3_framework/angel3_framework.dart';
|
import 'package:angel3_framework/angel3_framework.dart';
|
||||||
import 'package:angel3_static/angel3_static.dart';
|
import 'package:angel3_static/angel3_static.dart';
|
||||||
import 'package:file/file.dart';
|
import 'package:file/file.dart';
|
||||||
|
|
|
@ -1,6 +1,4 @@
|
||||||
/// Declare services here!
|
/// Declare services here!
|
||||||
library myapp.services;
|
|
||||||
|
|
||||||
import 'dart:async';
|
import 'dart:async';
|
||||||
import 'package:angel3_framework/angel3_framework.dart';
|
import 'package:angel3_framework/angel3_framework.dart';
|
||||||
|
|
||||||
|
|
BIN
logo3.png
BIN
logo3.png
Binary file not shown.
Before Width: | Height: | Size: 16 KiB |
|
@ -1,8 +1,7 @@
|
||||||
name: angel
|
name: angel
|
||||||
version: 1.0.0
|
version: 1.0.0
|
||||||
description: A boilerplate template for building Angel3 application
|
description: A basic starter application for Angel3 framework
|
||||||
publish_to: none
|
publish_to: none
|
||||||
homepage: https://github.com/dukefirehawk/boilerplates
|
|
||||||
environment:
|
environment:
|
||||||
sdk: '>=2.12.0 <3.0.0'
|
sdk: '>=2.12.0 <3.0.0'
|
||||||
dependencies:
|
dependencies:
|
||||||
|
|
Loading…
Reference in a new issue