https://github.com/rishiosaur/box

OOTB experiment #1!
https://github.com/rishiosaur/box

Last synced: 11 months ago
JSON representation

OOTB experiment #1!

• Host: GitHub
• URL: https://github.com/rishiosaur/box
• Owner: rishiosaur
• License: mpl-2.0
• Created: 2021-03-20T16:55:46.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2021-04-05T22:00:17.000Z (about 5 years ago)
• Last Synced: 2025-04-13T22:12:33.182Z (about 1 year ago)
• Language: JavaScript
• Size: 583 KB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 📦 Box

![lint status](https://github.com/rishiosaur/box/workflows/lint/badge.svg)

![format status](https://github.com/rishiosaur/box/workflows/format/badge.svg)

![GitHub](https://img.shields.io/github/license/rishiosaur/box)

![GitHub issues](https://img.shields.io/github/issues/rishiosaur/box)

![GitHub contributors](https://img.shields.io/github/contributors/rishiosaur/box)

![GitHub last commit](https://img.shields.io/github/last-commit/rishiosaur/box)

A simple tutorial for implementing a React-like library. Uses `snabbdom` under the hood.

## How to use this?

0. Look through prerequisites from the [documentation](https://ootb.rishi.cx/react)

1. Clone the repository

```sh

git clone https://github.com/rishiosaur/box

```

2. Install the dependenices

```sh

yarn

```

3. Run the application

```sh

yarn start:dev

```

## Structure

| Branch                                           | Purpose                                                         |

| ------------------------------------------------ | --------------------------------------------------------------- |

| [main](https://z.rishi.cx/g/box/)                | Starting files to get to understand the codebase.               |

| [stage-1](https://z.rishi.cx/g/box/tree/stage-1) | Rendering our first components & inspecting the VDOM            |

| [stage-2](https://z.rishi.cx/g/box/tree/stage-2) | Support for functional components                               |

| [stage-3](https://z.rishi.cx/g/box/tree/stage-3) | Support for class components & a prototypal inheritance feature |

| [stage-4](https://z.rishi.cx/g/box/tree/stage-4) | Support for lifecycle hooks & adding state                      |

| [stage-5](https://z.rishi.cx/g/box/tree/stage-5) | Support for events & basic props                                |

| [stage-6](https://z.rishi.cx/g/box/tree/stage-6) | Building a basic Todo list app                                  |

### Navigating branches

Each branch represents a different stage in the project, and you can run `git checkout ` to switch to that branch's final commit. For instance, to check out what's going on in the 5th stage, you might run `git checkout stage-5` after cloning.

## License

MPL-2.0 © [Rishi Kothari](mailto:hey@rishi.cx)