@typetron/framework 0.5.8 → 0.5.9

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2019] [Ionel-Cristian Lupu]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Readme.md

@@ -0,0 +1,123 @@
+# Typetron
+> **Note:** This project is a prototype in heavy development and not ready for production. 
+
+**[Typetron](https://typetron.org)** is a **modern web framework** built for Node.js, written in **Typescript**, that
+allows you to build fully featured web applications. 
+Typetron is best suited for small sized to enterprise level apps.
+Most of the core packages it uses were built from scratch in order to preserve the performance of the framework. 
+
+_(check [this tutorial](https://typetron.org/tutorials/blog) on how to get started with Typetron)_
+
+### Prerequisites
+- [NodeJs >=12 LTS](https://nodejs.org)
+
+#### Features
+Typetron aims to have all the features necessary for building any web app without the need for you
+to search the internet for a package to use. Almost all the packages it has were built from scratch and are 
+available in the framework. 
+This was done to ensure that all the features you are using benefit from the latest language features. 
+Also, every package can be tuned for performance or updated in no time if needed.
+
+##### Features List
+
+[typetron.org](https://typetron.org/docs/)
+
+##### Performance
+Being built with packages created from scratch using the latest features of the language, Typetron comes with
+excellent performance out of the box compared to other available frameworks.
+
+##### Developer experience
+Typetron's source code is built around developer's expectations: it is modern, clean and beautiful.
+Also, the tools Typetron is providing are everything a developer needs to build his next awesome project.
+
+##### Code sharing
+A few years ago we wrote websites. Nowadays we write web applications. The web evolved alongside the tools we are
+using. A typical web application is composed of at least two parts: a backend app and a frontend app.
+This separation led to two different camps that have a very distinct line between them. Typetron provides tools to make
+these two camps work together. 
+
+#### Source code examples
+
+##### Entities 
+```ts
+export class User extends Entity {
+
+    @PrimaryColumn()
+    id: number;
+
+    @Column()
+    email: string;
+
+    @Column()
+    name: string;
+
+    @Relation(() => Post, 'author')
+    posts: HasMany<Post> = [];
+
+    @Relation(() => Group, 'users')
+    group: BelongsTo<Group>;
+}
+```
+##### Forms
+```ts
+export class UserForm extends Form {
+    @Field()
+    @Rules(
+        Required,
+    )
+    email: string;
+
+    @Field()
+    @Rules(
+        Required,
+        MinLength(5),
+    )
+    name: string;
+
+    @Field()
+    dateOfBirth: Date;
+}
+``` 
+
+##### Controllers
+
+```ts
+@Controller('users')
+export class UserController {
+
+    @Inject()
+    storage: Storage;
+    
+    @AuthUser()
+    user: User;
+
+    @Get('me')
+    async me() {
+        return this.auth.user;
+    }
+
+    @Get()
+    async browse() {
+        return UserModel.from(User.get());
+    }
+
+    @Get(':User')
+    read(user: User) {
+        return user;
+    }
+
+    @Put(':User')
+    update(user: User, userForm: UserForm) {
+        return user.fill(userForm).save();
+    }
+
+    @Post()
+    create(userForm: UserForm) {
+        return User.create(userForm);
+    }
+}
+
+```
+
+## License
+This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.

package/package.json

@@ -2,7 +2,7 @@
     "name": "@typetron/framework",
     "description": "Modern Node.js framework for modern apps written in Typescript",
     "license": "MIT",
-    "version": "0.5.8",
+    "version": "0.5.9",
     "keywords": [
         "typetron",
         "framework",
@@ -15,7 +15,7 @@
         "name": "Ionel Lupu"
     },
     "scripts": {
-        "build": "tsc && cp package.json build/",
+        "build": "tsc && cp package.json build/ && cp Readme.md build/ && cp LICENSE.md build/ && cp package-lock.json build/",
         "dev": "tsc --watch",
         "test": "mocha",
         "test:watch": "mocha --watch",