Kudoo

• Prerequisites
• Credentials
• Running a local dev environment

Prerequisites

You'll need to have the following running on your local machine

• Node
• Docker
• Docker compose
• Postgres or MySQL

For Node we'd suggest install NVM. If you're using Windows then please use NVM-Windows

Please note We will always use the long term release supported version of Node. Currently this is 14.

You'll need to have the following global packages installed npm install -g pm2

Please note We use Arweave to store files.

Credentials

You will now need to setup your environmental variables.

Copy the env.sample file to two new files:

• .env
• .env.development

And then configure the variables.

Here's an example config

# FRONTEND
NODE_ENV=development
GRAPHQL_API_URL=http://localhost:3000/api/
SKELM_BASE_URL=http://localhost:3000

Running a local dev environment

Non Windows based OS

If you are on Linux or MacOS you can simply run the following command bash ./run.sh

Windows

We are currently working on getting a Powershell script working.