2.0.0 • Published 4 months ago
nodejs_file_structure v2.0.0
███╗ ██╗ ███████╗ ███████╗
████╗ ██║ ██╔════╝ ██╔════╝
██╔██╗ ██║ █████╗ ███████╗
██║╚██╗██║ ██╔══╝ ╚════██║
██║ ╚████║ ██║ ███████║
╚═╝ ╚═══╝ ╚═╝ ╚══════╝
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ┃
┃ ✨ Create modern project structures in seconds ✨ ┃
┃ ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
📋 Overview
NFS (Node.js File Structure) is a powerful CLI tool that helps you generate well-organized project structures for various frameworks with a single command. Say goodbye to manual folder creation and boilerplate setup!
✅ Features
💻 Installation
# Install globally for access from anywhere
npm install -g nodejs_file_structure
🔍 Usage
Simply run the command and follow the interactive prompts:
generate-structure
OR
nfs
⚙️ Available Templates
🔷 Express with Prisma
Modern Node.js API with type-safe database access
🔶 Express with Sequelize
Traditional Node.js API with robust ORM
💙 React Web Application
Well-organized React web application structure
💜 React Native Mobile Application
Complete React Native mobile app structure
🚀 Getting Started
Here's a quick example of setting up a new Express project:
? 🔍 Which project template do you want to use? Express - Node.js web framework
? 💼 Enter your project name: my-awesome-api
? 🗃️ Select your preferred ORM: Prisma - Next-gen ORM with type safety
🚀 Creating Express project: my-awesome-api
✓ Template repository cloned successfully
✓ Project customized successfully
🎉 Project setup complete! 🎉
To get started:
cd my-awesome-api
npm install
npm start
💡 Pro Tips
📈 Why Use NFS?
- Save Time: Skip the repetitive setup of folders and files
- Consistency: Maintain the same structure across all your projects
- Best Practices: Templates follow established patterns for each framework
- Focus on Code: Jump straight into development without setup hassle
🙏 Contributing
Contributions are welcome! Feel free to open an issue or submit a pull request.
📄 License
Request Feature Report Bug ·