Development Onboarding

1. Prerequisites

# Install Homebrew
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install Node.js, PostgreSQL v14.5, Redis
brew install node
brew install postgresql@14
brew install redis

# Start PostgreSQL and Redis
brew services start postgresql@14
brew services start redis

# Create database user
sudo -u postgres createuser -s root -P

# Set the password to "root" when prompted for a password (no quotes)

# Set up the database
createdb cubedesk -U root

2. Setup development environment

# Change to the directory where you want the CubeDesk codebase to exist. Example:
cd ~/Desktop

# Clone the CubeDesk repository
git clone https://github.com/kash/cubedesk.git

# Install yarn
npm install --global yarn

# Install all packages
yarn

# Update .default.env name
mv .default.env .env

# Initiate database tables
npx prisma format
npx prisma generate
npx prisma migrate dev

4. Start server

# Start the server and open the development site!
yarn dev
open http://localhost:3000