Table of Contents
CartDevKit is an all-in-one package to help you get started building your project on Cartesi. The CartDevKit CLI tool is designed to streamline the process of setting up new projects by providing developers with a wide range of templates for backend, frontend, Cartesify, and mobile development.
CartDevKit requires Node.js minimum version requirement is Node v.20+ and npm to be installed on your system. Ensure that you have the latest versions of Node.js and npm installed before proceeding with the installation.
To create a new project, run this command
npx cartdevkit@latest create mydappYou should see something like this
Replace mydapp with the desired name of your project. This command will prompt you to select a template and configure the project settings.
View available command-line options and flags by running
cartdevkit --helpTo setup your backend here are the required steps:
-
Navigate to the backend directory of your created project and run the below command, keep in mind also ensure your docker is all setup up and running.
-
Install all required dependencies using either
yarn installornpm i
To build and run the backend ensure that you have Cartesi CLI is installed and your docker is up and running. For debugging purpose you can run cartesi doctor.
-
Build the project by running the below command;
cartesi build
This will help build the image and run the Cartesi machine. Once this step is completed you should see something like this
The next step will be to start the local server by running
cartesi runIf all goes well you should see this
For quick troubleshooting incase you run into any issue you can quickly check the status using
cartesi doctorThis will start the development server
If you are working on the frontend, here are the required steps:
- Navigate into the frontend project directory
- Install all required dependencies using either
npm ioryarn install
Once you generate the frontend template, ensure to create a .env file and provide your project Id as it's an important requirement when working with Rainbowkit and wagmi.
Your .env file should look like this 👇 on the nextjs template
NEXT_PUBLIC_WALLECT_CONNECT_PROJECT_ID= YOUR PROJECT IDIf using the react-app template your .env file should look like this 👇 on the nextjs template
VITE_WALLET_CONNECT_PROJECT_ID= YOUR PROJECT ID- Start up the local server using the below command.
npm run dev Detailed setup guide can be found in the readme of the individual template.
- Backend (JavaScript, TypeScript)
- Frontend (React, NestJS)
- Cartesify (Backend and Frontend)
Checkout the individual docs to learn more about the template.
CartdevKit supports backend templates in various programming languages, including;
Each backend template comes with a basic project structure and configuration files.
Frontend templates are available for popular frameworks such as
These templates include components, routing, and styling to kickstart front-end development.
Cartesify templates integrate the Cartesi platform for both backend and frontend development. These templates enable developers to build scalable and secure applications using Cartesi's REST API technology.
The Cartesify template has support for both backend and frontend integration.
- Frontend : React App Template, Nextjs App Template
- Backend : Javascript Template, Typescript Template
- Cartesi Rollup
- Cartesi CLI
- Deroll/Cartesi Wallet
- Deroll/Cartesi Router
- Cartesify
- Node and Yarn Packages
- Figlet, fs-extra,inquirer, path shelljs, child_process,commander
- React
- Nextjs
- JavaScript
- TypeScript
To read a more comprehensive version of this doc visit here
Check out this playlist to get started using the CLI tool.
Join the Cartesi Discord server. You can also connect with the team here @africinnovate
See the open issues for a full list of proposed features (and known issues).
We welcome contributions from the community.
CartdevKit is licensed under the Apache License. Refer to the LICENSE file for more details