Skip to content
forked from agile-ts/agile

AgileTs is a global, simple, spacy State and Logic Framework supporting React

License

Notifications You must be signed in to change notification settings

codeway-0841/agile

 
 

Repository files navigation

AgileTs

AgileTs is a spacy, fast, simple State Management Framework


GitHub License npm minified size npm total downloads

Build Status Build Status Coverage Badge

Tweet Join Discord


How to create a State?

// -- core.js ------------------------------------------

// Let's start by creating an Instance of AgileTs
const App = new Agile();

// Now we are able to build our first State 😃
const MY_FIRST_STATE = App.createState("Hello Stranger!");


// -- myComponent.whatever ------------------------------------------

// Finally, we bind our just created State to our desired UI-Component
// And wolla its reactive. Everytime the State mutates the Component gets rerendered
const myFirstState = useAgile(MY_FIRST_STATE); // returns value of State ("Hello Stranger!")

To find out more checkout our documentation.

⛳️ Sandbox

Test AgileTs yourself, it's only one click away. Just select your preferred Framework below.

  • React
  • Vue (coming soon)
  • Angular (coming soon)

More examples can be found in the Example Section.



Why should I use AgileTs?

AgileTs is a simple, fast and well tested State Management Framework which is implemented in TypeScript. It's more flexible and boilerplate free than Redux and has an interesting approach to reducing the size of a codebase through a centralized memory design pattern. The philosophy behind AgileTs is simple:

🚅 Straightforward

Write minimalistic, boilerplate free code that captures your intent.

Some straightforward syntax examples:

  • Store State in any Storage, like Local Storage
    MY_STATE.persist("storage-key")
  • Create a reactive Array of States
    const MY_COLLECTION = App.createCollection();
    MY_COLLECTION.collect({id: 1, name: "Frank"});
    MY_COLLECTION.collect({id: 2, name: "Dieter"});
  • Mutate or Check States with simple Functions
    MY_STATE.undo(); // Undo latest change
    MY_STATE.is({hello: "jeff"}); // Check if State has the Value '{hello: "jeff"}'

🤸‍ Flexible

  • Works in nearly every UI-Framework. Check here if your preferred framework is supported too.
  • Surly behaves with the workflow that suits you best. No need for reducers, actions, ..
  • Has no external dependencies

🎯 Easy to Use

Learn the powerful tools of AgileTs in a short amount of time. A good place to start are our Quick Starts or if you are no fan of following any tutorial, checkout your examples.



Installation

To properly use AgileTs, in a UI-Framework we need two packages.

  • The Core Package, which acts as the brain of AgileTs and manages all our States

    npm install @agile-ts/core
    
  • and a fitting Integration for our preferd UI-Framework.. in my case the React Integration. Check here if your desired Framework is supported, too.

    npm install @agile-ts/react
    


Documentation

If AgileTs sounds interesting to you. Checkout our docs. And I am sure you will be able to use it in no time. In case you have any questions don't mind joining our Discord Community.



Contribute

Get a part of AgileTs and start contributing. To find out more checkout the CONTRIBUTING.md. We welcome any meaningful contribution 😀

Maintainability

Packages of Agile

Name Latest Version Description
@agile-ts/core badge Brain of Agile
@agile-ts/react badge React Integration
@agile-ts/api badge Promise based Api
@agile-ts/multieditor badge Simple Form Manager


Credits

AgileTs is inspired by MVVM frameworks like MobX and PulseJs.

About

AgileTs is a global, simple, spacy State and Logic Framework supporting React

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.7%
  • Other 1.3%