Thanks to visit codestin.com
Credit goes to github.com

Skip to content

SHNK is a CLI tool made for developers to automate there App creation tasks like installing ReactJS then installing TailwindCSS then configuring it, It does all itself even opens the LocalHost for you, It can create your NEXTJS project and Backend with authentication with just one click.

Notifications You must be signed in to change notification settings

Ganesh-Sharmaz/SHNK

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 SHNK - A simple CLI tool for automating daily tasks of a developer

A safe, futuristic, and developer-focused terminal CLI built in Python that combines aesthetics with practical development utilities.

✨ Features

🛠️ Developer Tools

  • Project Scaffolding
    • React + Tailwind CSS setup
    • Next.js + Tailwind CSS setup (coming soon)
    • Automated configuration and dependencies
    • Development server launch

🚀 Getting Started

Prerequisites

  • Python 3.8 or higher
  • pip (Python package manager)

Installation

  1. Clone the repository:
git clone https://github.com/yourusername/shnk.git
cd shnk
  1. Create and activate a virtual environment:
python -m venv .venv
# On Windows
.venv\Scripts\activate
# On Unix or MacOS
source .venv/bin/activate
  1. Install dependencies:
pip install -r requirements.txt
  1. Run the application:
python main.py

🏗️ Project Structure

SHNK/
├── main.py                 # Application entry point
├── banner.py              # ASCII art and animations
├── commands/              # Project scaffolding commands
│   ├── react_tailwind.py
│   └── next_tailwind.py
├── terminal/              # Terminal functionality
│   ├── fs_commands.py
│   └── sandbox.py
├── utils/                 # Helper functions
│   ├── installer.py
│   └── logger.py
├── config/               # Configuration files
│   └── settings.json
├── assets/              # Static assets
│   └── ascii.txt
├── requirements.txt     # Project dependencies
└── README.md

🛠️ Development

Building from Source

  1. Install development dependencies:
pip install -r requirements.txt
  1. Run the development version:
python main.py

Creating an Executable

pyinstaller --onefile --clean --icon=assets/shnk.ico --name SHNK main.py

📝 License

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

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  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

🐛 Known Issues

  • Next.js project scaffolding is currently in development
  • Some terminal commands are still being implemented

🔮 Roadmap

  • Vue.js + Tailwind project scaffolding
  • Express.js project setup
  • Command autocomplete
  • Custom themes support
  • Plugin system

📫 Contact

Ganesh Sharma - @Ganesh_Sharmazz

Project Link: https://github.com/Ganesh-Sharma/SHNK

About

SHNK is a CLI tool made for developers to automate there App creation tasks like installing ReactJS then installing TailwindCSS then configuring it, It does all itself even opens the LocalHost for you, It can create your NEXTJS project and Backend with authentication with just one click.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages