Skip to content

varunKT001/tomperjs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

8f0a7c9 · Sep 30, 2022

History

33 Commits
Sep 30, 2022
Jul 17, 2022
Aug 5, 2022
Jul 16, 2022
Jul 17, 2022
Sep 30, 2022
Aug 5, 2022
Aug 5, 2022
Jul 17, 2022
Aug 5, 2022
Jul 16, 2022
Jul 17, 2022

Repository files navigation

A classic Web-Framework

Docs | NPM Registry


🧾 Description

TomperJS is a web-framework based on MVC(Model-View-Controller) architecture pattern. It is very similar to one of the most popular web-framework BackboneJS

💿 Installation

npm i --save @varuntiwari/tomperjs

🏁 Example

import { View } from '@varuntiwari/tomperjs';

class MyView extends View {
  template() {
    return `
    <div>
      <h1>Awesome App</h1>
    </div>
    `;
  }
}

const root = document.getElementById('root');

if (root) {
  // Create view
  const myView = new MyView(root);
  // Render the view
  myView.render();
}

✨ Features

  • Uses Model-View-Controller pattern.
  • Collection support for handling multiple models of similar type.
  • Reactive views which reacts to change on a Model.
  • User and custom events support using Eventing module.
  • Built-in standard API controllers like fetch() and save().

⚙ Tools and Technologies used

  1. Typescript
  2. Axios

🛠 Local Installation and setup

  1. Clone the repo to your local machine.

  2. Install the required dependency for server using :

    npm install

🏎 Creating production built

  1. Build the package using

    npm run build
  2. Update the Docs using

    npm run docs

😎 Team Members

GSSoC'22
Varun Kumar Tiwari
LinkedIn Github

⚖ License

GPL-3.0




(If you liked the project, give it star 😃)

Releases

No releases published

Packages

No packages published