mirror of
https://github.com/makeplane/plane
synced 2025-08-07 19:59:33 +00:00
28f9733d1b
* chore: local dev improvements * chore: pr feedback * chore: fix setup * fix: env variables updated in .env.example files * fix(local): sign in to admin and web * chore: update minio deployment to create an bucket automatically on startup. * chore: resolve merge conflict * chore: updated api env with live base path --------- Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com> Co-authored-by: pablohashescobar <nikhilschacko@gmail.com>
95 lines
3.2 KiB
Bash
Executable File
95 lines
3.2 KiB
Bash
Executable File
#!/bin/bash
|
|
|
|
# Plane Project Setup Script
|
|
# This script prepares the local development environment by setting up all necessary .env files
|
|
# https://github.com/makeplane/plane
|
|
|
|
# Set colors for output messages
|
|
GREEN='\033[0;32m'
|
|
BLUE='\033[0;34m'
|
|
YELLOW='\033[1;33m'
|
|
RED='\033[0;31m'
|
|
BOLD='\033[1m'
|
|
NC='\033[0m' # No Color
|
|
|
|
# Print header
|
|
echo -e "${BOLD}${BLUE}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
|
|
echo -e "${BOLD}${BLUE} Plane - Project Management Tool ${NC}"
|
|
echo -e "${BOLD}${BLUE}━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━${NC}"
|
|
echo -e "${BOLD}Setting up your development environment...${NC}\n"
|
|
|
|
# Function to handle file copying with error checking
|
|
copy_env_file() {
|
|
local source=$1
|
|
local destination=$2
|
|
|
|
if [ ! -f "$source" ]; then
|
|
echo -e "${RED}Error: Source file $source does not exist.${NC}"
|
|
return 1
|
|
fi
|
|
|
|
cp "$source" "$destination"
|
|
|
|
if [ $? -eq 0 ]; then
|
|
echo -e "${GREEN}✓${NC} Copied $destination"
|
|
else
|
|
echo -e "${RED}✗${NC} Failed to copy $destination"
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
# Export character encoding settings for macOS compatibility
|
|
export LC_ALL=C
|
|
export LC_CTYPE=C
|
|
echo -e "${YELLOW}Setting up environment files...${NC}"
|
|
|
|
# Copy all environment example files
|
|
services=("" "web" "apiserver" "space" "admin" "live")
|
|
success=true
|
|
|
|
for service in "${services[@]}"; do
|
|
prefix="./"
|
|
if [ "$service" != "" ]; then
|
|
prefix="./$service/"
|
|
fi
|
|
|
|
copy_env_file "${prefix}.env.example" "${prefix}.env" || success=false
|
|
done
|
|
|
|
# Generate SECRET_KEY for Django
|
|
if [ -f "./apiserver/.env" ]; then
|
|
echo -e "\n${YELLOW}Generating Django SECRET_KEY...${NC}"
|
|
SECRET_KEY=$(tr -dc 'a-z0-9' < /dev/urandom | head -c50)
|
|
|
|
if [ -z "$SECRET_KEY" ]; then
|
|
echo -e "${RED}Error: Failed to generate SECRET_KEY.${NC}"
|
|
echo -e "${RED}Ensure 'tr' and 'head' commands are available on your system.${NC}"
|
|
success=false
|
|
else
|
|
echo -e "SECRET_KEY=\"$SECRET_KEY\"" >> ./apiserver/.env
|
|
echo -e "${GREEN}✓${NC} Added SECRET_KEY to apiserver/.env"
|
|
fi
|
|
else
|
|
echo -e "${RED}✗${NC} apiserver/.env not found. SECRET_KEY not added."
|
|
success=false
|
|
fi
|
|
|
|
# Activate Yarn (version set in package.json)
|
|
corepack enable yarn || success=false
|
|
# Install Node dependencies
|
|
yarn install || success=false
|
|
|
|
# Summary
|
|
echo -e "\n${YELLOW}Setup status:${NC}"
|
|
if [ "$success" = true ]; then
|
|
echo -e "${GREEN}✓${NC} Environment setup completed successfully!\n"
|
|
echo -e "${BOLD}Next steps:${NC}"
|
|
echo -e "1. Review the .env files in each folder if needed"
|
|
echo -e "2. Start the services with: ${BOLD}docker compose -f docker-compose-local.yml up -d${NC}"
|
|
echo -e "\n${GREEN}Happy coding! 🚀${NC}"
|
|
else
|
|
echo -e "${RED}✗${NC} Some issues occurred during setup. Please check the errors above.\n"
|
|
echo -e "For help, visit: ${BLUE}https://github.com/makeplane/plane${NC}"
|
|
exit 1
|
|
fi
|