π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
feat: improve setup.sh script with better error handling and user feedback (#6758)
bIaO0efb0c239c72
diff --git a/setup.sh b/setup.shindex 2376cb0016..2dcaba80f2 100755--- a/setup.sh+++ b/setup.sh@@ -1,15 +1,89 @@#!/bin/bash-cp ./.env.example ./.env-# Export for tr error in mac+# 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 compatibilityexport LC_ALL=Cexport 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-cp ./web/.env.example ./web/.env-cp ./apiserver/.env.example ./apiserver/.env-cp ./space/.env.example ./space/.env-cp ./admin/.env.example ./admin/.env-cp ./live/.env.example ./live/.env+# 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-# Generate the SECRET_KEY that will be used by django-echo -e "\nSECRET_KEY=\"$(tr -dc 'a-z0-9' < /dev/urandom | head -c50)\"" >> ./apiserver/.env+# 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