Skip to content

Latest commit

Β 

History

History
89 lines (57 loc) Β· 2.81 KB

README.md

File metadata and controls

89 lines (57 loc) Β· 2.81 KB

Tatami is a project designed to accelerate the development of Dojo Engine games within the Starknet ecosystem. It provides no-code tools to effortlessly create models, visualize entity relationships, and make modifications with just a few clicks. With Tatami, you can master the Dojo and build 10x faster.

πŸš€ Getting Started

πŸ“¦ Dependencies

  • Node.js version 18.18 or higher

  • npm version 10.9.2 or higher

    • Refer to the npm official documentation for detailed instructions.

    • To check your installed npm version:

      npm -v
    • To globally install or update npm to version 10.9.2:

      npm install -g npm@10.9.2

      After updating, recheck the version using npm -v.

πŸ’‘ Installation process

  1. Fork the repository

  2. Clone the repository:

    git clone https://github.com/your-username/Tatami.git
    cd Tatami
  3. Install dependencies:

    • Install the global dependencies for the monorepo and its workspaces:
    npm install

    This will install all the necessary dependencies for the applications within the apps/* subdirectories.

βš™οΈ Available Commands

  • npm run dev - Starts the development server of all applications.
  • npm run build - Builds the production version of all applications.
  • npm run lint - Runs the linter configured of all applications.

πŸ› οΈ Adding Dependencies

If you need to add a dependency to any of the applications within the monorepo, you must navigate to the respective application directory and then install the dependency from there.

🎯 Running Specific Applications

Run individual applications directly from the root directory:

  1. Frontend:

    npm run dev:frontend

🀝 Contributing

We welcome contributions from the community! Whether it's bug fixes, new features, or improvements, your help is appreciated.

πŸ”Ή Check out our Contribution Guidelines: Contribution Guidelines
πŸ”Ή Report Issues & Suggest Features: Open an issue on GitHub
πŸ”Ή Fork & Submit a PR: Follow best practices and submit your pull request

Conquer the Dojo with Tatami πŸ₯‹

Let's build together! πŸš€πŸ€„


banner