Skip to content

Latest commit

 

History

History
136 lines (103 loc) · 3.98 KB

README.md

File metadata and controls

136 lines (103 loc) · 3.98 KB

Project Initialization Scripts 🚀

Welcome to the Project Initialization Scripts repository! This collection of scripts helps you set up initial folder and file structures for various types of applications, simplifying your project setup process. The scripts are available in .shell and .bat formats for Linux and Windows environments, respectively.

Table of Contents 📚

  1. Introduction
  2. Project Structure
  3. Supported Project Types
  4. Prerequisites
  5. Usage
  6. Contribution Guidelines
  7. Best Practices
  8. FAQs
  9. License
  10. Contact

1. Introduction 🌟

This repository contains a collection of scripts to create initial folder and file structures for various types of applications. The scripts are organized into two main directories: one for Linux (.shell scripts) and one for Windows (.bat scripts). Each directory contains subdirectories for different types of projects.

2. Project Structure 📁

project-initialization-scripts/
│
├── Linux/
│   └── python/
│       └── setup-python-ai.sh
│
└── Windows/
    └── python/
        └── setup-python-ai.bat

3. Supported Project Types 🛠️

  1. Python AI Projects
    • (Other project types will be added in the future)

4. Prerequisites 📋

Before using the scripts, ensure you have the following installed on your system:

Linux

  • Bash

Windows

  • Command Prompt or PowerShell

5. Usage ⚙️

Linux

  1. Python AI Projects
    • Navigate to the Linux/python directory: 
      cd Linux/python
    • Copy the setup-python-ai.sh file to your project folder: 
      cp setup-python-ai.sh /path/to/your/project/folder
    • Navigate to your project directory: 
      cd /path/to/your/project/folder
    • Make the script executable: 
      chmod +x setup-python-ai.sh
    • Run the setup-python-ai.sh script: 
      ./setup-python-ai.sh

Windows

  1. Python AI Projects
    • Navigate to the Windows\python directory: 
      cd Windows\python
    • Copy the setup-python-ai.bat file to your project folder: 
      copy setup-python-ai.bat C:\path\to\your\project\folder
    • Navigate to your project directory: 
      cd C:\path\to\your\project\folder
    • Run the setup-python-ai.bat script: 
      setup-python-ai.bat

6. Best Practices 🌟

  • Keep scripts modular and focused on single tasks.
  • Follow coding standards and naming conventions.
  • Document your scripts thoroughly.
  • Test scripts on both Linux and Windows environments before submitting.

7. Contribution Guidelines 🤝

We welcome contributions! Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request.

8. FAQs ❓

Q: What if I encounter an error while running a script? A: Ensure all prerequisites are installed and your environment is correctly set up. Check the script permissions and paths.

Q: Can I add support for a new project type? A: Absolutely! Fork the repository, add your scripts, and submit a pull request.

9. License 📄

This project is licensed under the MIT License. See the LICENSE file for details.

10. Contact 📬

For any inquiries or feedback, please reach out via email at tanabebruno@gmail.com or open an issue on GitHub.

Thank you for using the Project Initialization Scripts! Happy coding! 🎉