Moved docs to root and added README.md

RicardoRB · Aug 24, 2022 · 0a67a85 · 0a67a85
1 parent a18270d
commit 0a67a85
Show file tree

Hide file tree

Showing 13 changed files with 128 additions and 20 deletions.
diff --git a/README.md 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
+   - <del>Controllers</del>
+      - <del>Bind annotations</del>
+      - <del>Header</del>
+      - <del>Body</del>
+      - <del>Param</del>
+      - <del>Query</del>
+   - <del>Middleware</del>
+   - <del>Interceptor</del>
+   - Websockets
+2. Exceptions
+   - <del>Exception Handler</del>
+3. Security
+   - Security interceptors(?)
+   - CORS
+4. Dependency Injection
+   - Injectable
+5. Scheduling
+   - Annotation
+6. Database
+   - ORM
+   - Repository
+7. Testing
+8. CLI
+9. Hot reload
diff --git a/packages/dartness_server/docs/.nojekyll → docs/.nojekyll b/packages/dartness_server/docs/.nojekyll → docs/.nojekyll
diff --git a/packages/dartness_server/docs/README.md → docs/README.md b/packages/dartness_server/docs/README.md → docs/README.md
diff --git a/packages/dartness_server/docs/_sidebar.md → docs/_sidebar.md b/packages/dartness_server/docs/_sidebar.md → docs/_sidebar.md
diff --git a/packages/dartness_server/docs/controllers.md → docs/controllers.md b/packages/dartness_server/docs/controllers.md → docs/controllers.md
diff --git a/packages/dartness_server/docs/exceptions.md → docs/exceptions.md b/packages/dartness_server/docs/exceptions.md → docs/exceptions.md
diff --git a/packages/dartness_server/docs/first_steps.md → docs/first_steps.md b/packages/dartness_server/docs/first_steps.md → docs/first_steps.md
diff --git a/packages/dartness_server/docs/flutter.md → docs/flutter.md b/packages/dartness_server/docs/flutter.md → docs/flutter.md
diff --git a/packages/dartness_server/docs/index.html → docs/index.html b/packages/dartness_server/docs/index.html → docs/index.html
diff --git a/packages/dartness_server/docs/interceptor.md → docs/interceptor.md b/packages/dartness_server/docs/interceptor.md → docs/interceptor.md
diff --git a/packages/dartness_server/docs/middleware.md → docs/middleware.md b/packages/dartness_server/docs/middleware.md → docs/middleware.md
diff --git a/packages/dartness_server/docs/quickstart.md → docs/quickstart.md b/packages/dartness_server/docs/quickstart.md → docs/quickstart.md
diff --git 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
-    - <del>Controllers</del>
-        - <del>Bind annotations</del>
-        - <del>Header</del>
-        - <del>Body</del>
-        - <del>Param</del>
-        - <del>Query</del>
-    - <del>Middleware</del>
-    - <del>Interceptor</del>
-    - Websockets
+   - <del>Controllers</del>
+      - <del>Bind annotations</del>
+      - <del>Header</del>
+      - <del>Body</del>
+      - <del>Param</del>
+      - <del>Query</del>
+   - <del>Middleware</del>
+   - <del>Interceptor</del>
+   - Websockets
 2. Exceptions
-    - <del>Exception Handler</del>
+   - <del>Exception Handler</del>
 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