Skip to main content

Install

Follow the steps below to start your own version of Kitty Items.

Video Walkthrough

Check prerequisites

Before moving to the next step, ensure you have the following tools installed:

NodeJS

Ensure you have NodeJS installed. Version 16+ is required.


_10
> node -v
_10
_10
v16.x.x

📣 Tip: Need to manage different versions of NodeJS? Try using NVM.

Flow CLI

Ensure you have the Flow CLI. Version 0.32.3+ is required.


_10
> flow version
_10
_10
Version: v0.32.3

Clone the project

To get started, clone the project to your machine:


_10
git clone https://github.com/onflow/kitty-items.git

A new folder, kitty-items, will be created. You will work in this folder, so navigate into it:


_10
cd kitty-items

Install dependencies

In the project directory, run the following command to install all dependencies:


_10
npm install

Note: This process may take a few seconds and you will see some logs. This is expected.

Once the installation is completed, you are ready to start the project.

Apple M1 compatibility

In case you are on an Apple M1 machine, you have to install another package to run the web application on your system.

If you are not aware of the system you are running, run the following command in your terminal:


_10
> npx envinfo --system
_10
_10
npx: installed 1 in 1.161s
_10
_10
System:
_10
OS: macOS 12.2.1
_10
CPU: (8) x64 Apple M1 Pro
_10
Memory: 29.95 MB / 16.00 GB
_10
Shell: 5.8 - /bin/zsh

If the CPU mentions M1, you need to run this step.


_10
# move to the web folder
_10
cd web/
_10
_10
# install package
_10
npm i @next/swc-darwin-arm64
_10
_10
# move back to the project root
_10
cd ..

Note: This installation will fail if you are not on an Apple M1 machine. If you are on an Apple M1 machine and skip this step, your web application will not start successfully.

🚀