protevus/README.md

36 lines
1.1 KiB
Markdown
Raw Normal View History

2021-07-17 05:05:34 +00:00
# Graphql Starter Application for Angel3 framework
2016-12-27 14:28:48 +00:00
2021-09-25 10:39:19 +00:00
This is a graphql starter application for [Angel3 framework](https://angel3-framework.web.app) which is a full-stack Web framework in Dart.
2017-06-05 17:01:45 +00:00
2017-03-23 11:23:16 +00:00
## Installation & Setup
2017-04-02 20:32:03 +00:00
2021-07-17 05:05:34 +00:00
1. Download and install [Dart](https://dart.dev/get-dart).
2017-04-02 20:28:22 +00:00
2021-07-17 05:05:34 +00:00
### Development
2017-04-02 20:28:22 +00:00
2021-07-17 05:05:34 +00:00
1. Run the following command to start Angel3 server in dev mode to *hot-reloaded* on file changes:
2017-04-02 20:32:03 +00:00
2021-07-17 05:05:34 +00:00
```bash
dart --observe bin/dev.dart
```
2017-04-02 20:32:03 +00:00
2021-07-17 05:05:34 +00:00
2. Modify the code and watch the changes applied to the application
2017-04-02 20:32:03 +00:00
2021-07-17 05:05:34 +00:00
### Production
2017-04-02 20:38:20 +00:00
2021-07-17 05:05:34 +00:00
1. Run the following command:
2017-04-02 20:38:20 +00:00
2021-07-17 05:05:34 +00:00
```bash
dart bin/prod.dart
```
2017-04-02 20:32:03 +00:00
2021-07-17 05:05:34 +00:00
2. Run as docker. Edit and run the provided `Dockerfile` to build the image.
2019-04-18 16:18:39 +00:00
2021-07-17 05:05:34 +00:00
## Resources
2019-04-18 16:18:39 +00:00
2021-07-17 05:05:34 +00:00
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.
2019-04-18 16:18:39 +00:00
2021-09-25 10:39:19 +00:00
Examples and complete projects can be found [here](https://angel3-framework.web.app/#/examples).
2017-04-02 20:32:03 +00:00
2021-07-17 05:05:34 +00:00
You can also view the [API Documentation](https://pub.dev/documentation/angel3_framework/latest/).