0.0.1 • Published 6 years ago

@schwifts/schwifts v0.0.1

Weekly downloads
1
License
ISC
Repository
github
Last release
6 years ago

schwifty

install typescript. This will also include typescript compiler that will compile your TS code JS

npm install -g typescript

install schwifts framework

npm i @schwifts/schwifts --save

create the following files

  node_modules/
  src/
    index.ts
    router.ts
    environment.ts
    controller.ts

Example usage: responding to a GET request for path '/yo'

lets create a controller to handle your request

import { Controller } from '@schwifts/schwifts/controller/';
import {TemplateResponse} from '@schwifts/schwifts/http/HttpResponse'
import {Request}  from "@schwifts/schwifts/http";


export class HomeController extends Controller{


  constructor(request:Request, params:any){
    super(request,params)
  }

  get(){
    let response = new TemplateResponse("hello world")
    return response;
  }
}

lets create a router to route all your urls

import { Router } from '@schwifts/schwifts/router/';
import { HomeController } from './controller';


export class MainRouter extends Router{
  constructor(){
    super();
    this.add_route('/yo',HomeController,'home');
  }
}

create a new environment file and add your environment variables.

ROOT_ROUTER is used to build your routes

import { Environment } from '@schwifts/schwifts/core';
import { MainRouter } from './router'

export class LocalEnvironment extends Environment{
  constructor(){
    super();
    this.add_to_env("SECRET_KEY","1234567788");
    this.add_to_env("ROOT_ROUTER",MainRouter);

  }
}

Create an index file to bootstrap your application

import { Schwifts } from '@schwifts/schwifts/core'
import { LocalEnvironment } from './environments'

let env= new LocalEnvironment()
let conf = new Schwifts(env);
conf.get_schwifty(1729);

now compile your typescript file using typescript compiler. To do this, add tsconfig.json file to your root with the following config

{
  "compileOnSave": true,

  "compilerOptions": {
      "noImplicitAny": false,
      "removeComments": true,
      "preserveConstEnums": true,
      "outDir":"./build/",
      "sourceMap": true
  },

  "include": [
      "./src/**/*",
  ]
}

and run this command on your terminal to compile on watcher mode

tsc -w -p .

This will generate the build files in 'build/' directory when ever you save a file in your project

you can run the build using the following command

node build/src/