Skip to content

Latest commit

 

History

History
90 lines (68 loc) · 1.93 KB

readme.md

File metadata and controls

90 lines (68 loc) · 1.93 KB

XpressGen

Description

XpressGen is a powerful tool for generating customizable templates and streamlining project initialization. It provides modular, scalable, and easy-to-use components to accelerate development workflows.

Prerequisites

  • Python 3.8+
  • pip (Python package manager)

Installation

  1. Clone the repository:

    git clone https://github.com/achrafness/XpressGen.git
cd XpressGen

  2. Install dependencies:

    pip install -r requirements.txt

  3. Create symbolic links (optional):

    If you want to create a symbolic link to easily run XpressGen from anywhere, use the following command:

  • in Linux , macOs 
       sudo rm /usr/local/bin/xpressgen
   sudo ln -s $(pwd)/src/main.py /usr/local/bin/xpressgen
   sudo chmod +x /usr/local/bin/xpressgen
  • in windaws 
    soon
    After this, you can run the application using (go to your folder of porject) : 
    xpressgen         # If using a symbolic link
python src/main.py  # If not using a symbolic link

Project Structure

src/
├── core/               # Core project initialization
├── modules/            # Business logic modules
├── templates/          # Template generators
└── utils/              # Utility functions

Running the Application

python src/main.py

Or, if you have created a symbolic link:

xpressgen

Contributing

  1. Fork the repository.
  2. Create your feature branch: 
    git checkout -b feature/AmazingFeature
  3. Commit your changes: 
    git commit -m 'Add some AmazingFeature'
  4. Push to the branch: 
    git push origin feature/AmazingFeature
  5. Open a Pull Request.

Contact

Achraf Abdelouadoud - achraf.nessighaoui13@gmail.com
Project Link: Link