Install

Set up the project locally

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

Video Walkthrough

YouTube video player
YouTube video player
00:0

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.

1
> node -v
2
3
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.

1
> flow version
2
3
Version: v0.32.3

Clone the project

To get started, clone the project to your machine:

1
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:

1
cd kitty-items

Install dependencies

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

1
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:

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

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

1
# move to the web folder
2
cd web/
3
4
# install package
5
npm i @next/swc-darwin-arm64
6
7
# move back to the project root
8
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.