This repository contains a script to create a standardised project structure:
# Create project-structure.sh script
./project-structure.sh <project_name>
- Creates a structured directory hierarchy with 7 key areas
- Adds README files with descriptions in each directory
- Generates a main README with project documentation
- Shows the directory tree (if
tree
command is available)
<project_name>/
├── 1_Journey/ # Objectives and timeline tracking
├── 2_Real/ # Actual implementation and code
├── 3_Environment/ # Setup and configuration details
├── 4_UI/ # User interface and visual elements
├── 5_Formula/ # Technical procedures and documentation
├── 6_Symbols/ # Code implementation
└── 7_Semblance/ # Issue tracking and solutions
Clone this repository, then:
chmod +x project-structure.sh
./project-structure.sh my_new_project
To use this script in a different repository:
-
Copy the script to your target repository:
curl -O https://raw.githubusercontent.com/NawalC/project-structure-automation/blob/main/project-structure.sh
-
Make it executable:
chmod +x project-structure.sh
-
Run it in your target repository:
./project-structure.sh your_project_name
-
Alternatively, run it directly without saving:
bash <(curl -s https://raw.githubusercontent.com/NawalC/project-structure-automation/blob/main/project-structure.sh) your_project_name
Credits: Project structure inspired by rifaterdemsahin