ContextQMD
Back to Million

Million.js Kitchen Sink 🧑‍🍳

packages/kitchen-sink/README.md

3.1.72.6 KB
Original Source

Million.js Kitchen Sink 🧑‍🍳

Hey! We're actively recruiting cooks 🧑‍🍳 to help assemble a list of examples of Million + your favorite React library. View it live at sink.million.dev

Getting Started

To get started with the Million.js Kitchen Sink, follow these steps:

  1. Clone the Million.js repository:
bash
git clone https://github.com/aidenybai/million.git
cd million
  1. Install project dependencies using pnpm (pnpm is a package manager similar to npm and yarn, used for the Million.js project):
bash
pnpm install
  1. Navigate to the Kitchen Sink directory:
bash
cd packages/kitchen-sink

Running the Kitchen Sink

You can run the Kitchen Sink application to explore the various scenarios and examples:

bash
pnpm dev

This command will start the development server and open the Kitchen Sink application in your default web browser.

Examples

The Kitchen Sink showcases Million.js used in a variety of real-life scenarios, utilizing different technologies. Some of the examples you'll find include:

  • Jotai Counter: A simple counter built with React and that uses Jotai for managing state.
  • Tanstack Query: A simple application that uses the Tanstack data fetching library and showcases Million.js' usage.
  • ...

Each example comes with its own code and resources, demonstrating how Million.js can be integrated into different projects and workflows.

Adding a New Example

Just create a new file in packages/kitchen-sink/src/examples with the name of your example (e.g. super-epic.tsx). Make sure you export default a React component.

Contributing

We welcome contributions to the Million.js Kitchen Sink! If you have an interesting example, improvement, or bug fix, here's how you can contribute:

  1. Fork the Million.js repository.
  2. Create a new branch for your contribution.
  3. Make your changes and commit them.
  4. Push your changes to your forked repository.
  5. Create a pull request targeting the original Million.js repository.

Please make sure to follow our contribution guidelines and code of conduct when submitting your contribution.

Community and Support

If you have questions, need help, or want to discuss anything related to Million.js or the Kitchen Sink, you can:

License

The Million.js Kitchen Sink is open-source software licensed under the MIT License.