diff --git a/README.md b/README.md new file mode 100644 index 00000000..52586954 --- /dev/null +++ b/README.md @@ -0,0 +1,108 @@ +![Github Action](https://github.com/RicardoRB/dartness/actions/workflows/all.yml/badge.svg) +![Top Language](https://img.shields.io/github/languages/top/RicardoRB/dartness) +![License](https://img.shields.io/github/license/RicardoRB/dartness) +![Pub Likes](https://img.shields.io/pub/likes/dartness_server) +![Pub popularity](https://img.shields.io/pub/popularity/dartness_server) +![Pub version](https://img.shields.io/pub/v/dartness_server?include_prereleases) +![Stars](https://img.shields.io/github/stars/RicardoRB/dartness?style=social) + +# Introduction + +Dartness is a progressive dart framework for building efficient and scalable server-side applications. + +## Description + +Dartness is a framework for building efficient, scalable dart server-side applications. It provides an easy and quick +way to develop modern standalone server. + +Under the hood, Dartness makes use of [shelf](https://github.com/dart-lang/shelf). + +Inspired by [Spring Boot](https://github.com/spring-projects/spring-boot) and [Nest](https://github.com/nestjs/nest) +frameworks + +## Docs and more + +You can check the documentation at [dartness docs](https://ricardorb.github.io/dartness/) + +## Installation + +Install [Dart SDK](https://dart.dev/get-dart) version >=2.17.0 + +```bash +$ dart --version +Dart SDK version: 2.17.3 (stable) +``` + +## Creating a new project + +```bash +$ dart create -t console your_project_name +``` + +1. Add dartness into the pubspec.yaml + +```yaml +dependencies: + dartness_server: ^0.4.0-alpha + +dev_dependencies: + build_runner: ^2.2.0 + dartness_generator: ^0.1.0-alpha +``` + +2. Create the file in "bin/main.dart" + +```dart +void main() async { + final app = Dartness( + port: 3000, + ); + await app.create(); +} + +``` + +3. Run the server + +```bash +$ dart run bin/main.dart +Server listening on port 3000 +``` + +## Example + +You can run the example with the [Dart SDK](https://dart.dev/get-dart) +like this: + +``` +$ dart run example/main.dart +Server listening on port 3000 +``` + +## TODO + +1. HTTP + - Controllers + - Bind annotations + - Header + - Body + - Param + - Query + - Middleware + - Interceptor + - Websockets +2. Exceptions + - Exception Handler +3. Security + - Security interceptors(?) + - CORS +4. Dependency Injection + - Injectable +5. Scheduling + - Annotation +6. Database + - ORM + - Repository +7. Testing +8. CLI +9. Hot reload \ No newline at end of file diff --git a/packages/dartness_server/docs/.nojekyll b/docs/.nojekyll similarity index 100% rename from packages/dartness_server/docs/.nojekyll rename to docs/.nojekyll diff --git a/packages/dartness_server/docs/README.md b/docs/README.md similarity index 100% rename from packages/dartness_server/docs/README.md rename to docs/README.md diff --git a/packages/dartness_server/docs/_sidebar.md b/docs/_sidebar.md similarity index 100% rename from packages/dartness_server/docs/_sidebar.md rename to docs/_sidebar.md diff --git a/packages/dartness_server/docs/controllers.md b/docs/controllers.md similarity index 100% rename from packages/dartness_server/docs/controllers.md rename to docs/controllers.md diff --git a/packages/dartness_server/docs/exceptions.md b/docs/exceptions.md similarity index 100% rename from packages/dartness_server/docs/exceptions.md rename to docs/exceptions.md diff --git a/packages/dartness_server/docs/first_steps.md b/docs/first_steps.md similarity index 100% rename from packages/dartness_server/docs/first_steps.md rename to docs/first_steps.md diff --git a/packages/dartness_server/docs/flutter.md b/docs/flutter.md similarity index 100% rename from packages/dartness_server/docs/flutter.md rename to docs/flutter.md diff --git a/packages/dartness_server/docs/index.html b/docs/index.html similarity index 100% rename from packages/dartness_server/docs/index.html rename to docs/index.html diff --git a/packages/dartness_server/docs/interceptor.md b/docs/interceptor.md similarity index 100% rename from packages/dartness_server/docs/interceptor.md rename to docs/interceptor.md diff --git a/packages/dartness_server/docs/middleware.md b/docs/middleware.md similarity index 100% rename from packages/dartness_server/docs/middleware.md rename to docs/middleware.md diff --git a/packages/dartness_server/docs/quickstart.md b/docs/quickstart.md similarity index 100% rename from packages/dartness_server/docs/quickstart.md rename to docs/quickstart.md diff --git a/packages/dartness_server/README.md b/packages/dartness_server/README.md index c7ced5e0..52586954 100644 --- a/packages/dartness_server/README.md +++ b/packages/dartness_server/README.md @@ -20,6 +20,10 @@ Under the hood, Dartness makes use of [shelf](https://github.com/dart-lang/shelf Inspired by [Spring Boot](https://github.com/spring-projects/spring-boot) and [Nest](https://github.com/nestjs/nest) frameworks +## Docs and more + +You can check the documentation at [dartness docs](https://ricardorb.github.io/dartness/) + ## Installation Install [Dart SDK](https://dart.dev/get-dart) version >=2.17.0 @@ -75,34 +79,30 @@ $ dart run example/main.dart Server listening on port 3000 ``` -## Docs and more - -You can check the documentation at [dartness docs](https://ricardorb.github.io/dartness/) - ## TODO 1. HTTP - - Controllers - - Bind annotations - - Header - - Body - - Param - - Query - - Middleware - - Interceptor - - Websockets + - Controllers + - Bind annotations + - Header + - Body + - Param + - Query + - Middleware + - Interceptor + - Websockets 2. Exceptions - - Exception Handler + - Exception Handler 3. Security - - Security interceptors(?) - - CORS + - Security interceptors(?) + - CORS 4. Dependency Injection - - Injectable + - Injectable 5. Scheduling - - Annotation + - Annotation 6. Database - - ORM - - Repository + - ORM + - Repository 7. Testing 8. CLI 9. Hot reload \ No newline at end of file