.vscode | ||
bin | ||
config | ||
lib | ||
test | ||
views | ||
web | ||
.dockerignore | ||
.gitignore | ||
analysis_options.yaml | ||
CHANGELOG.md | ||
Dockerfile | ||
LICENSE | ||
pubspec.yaml | ||
README.md |
ORM Starter Application for Angel3 framework
This is an ORM starter application for Angel3 framework which is a full-stack Web framework in Dart. The default database is postgresql
. mysql
support is still in active development.
Installation & Setup
-
Download and install Dart.
-
Install
postgresql
version 10, 11, 12 and 13 -
Create a new user and database in postgres using
psql
cli. For example:postgres=# create database appdb; postgres=# create user appuser with encrypted password 'App1970#'; postgres=# grant all privileges on database appdb to appuser;
-
Update the
postgres
section in theconfig/default.yaml
file with the newly created user and database name.postgres: host: localhost port: 5432 database_name: appdb username: appuser password: App1970# useSSL: false time_zone: UTC
-
Run the migration to generate
migrations
andgreetings
tables in the database.dart bin/migrate.dart up
Development
-
Run the following command to start Angel3 server in dev mode to hot-reloaded on file changes:
dart --observe bin/dev.dart
-
Modify the code and watch the changes applied to the application
-
Insert a message into DB:
curl -H "Content-Type: application/json" -X POST -d '{"message":"OK_Message" }' "http://localhost:3000/greetings/"
or
curl -X POST -d 'message=OK_Message2' "http://localhost:3000/greetings/"
-
Query DB:
http://localhost:3000/greetings/
Production
-
Run the following command:
dart bin/prod.dart
-
Run as docker. Edit and run the provided
Dockerfile
to build the image.
Resources
Visit the Developer Guide 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.
You can also view the API Documentation.