Start your Node.js projects with ease! Banah JS automates the setup of your projects by installing essential dependencies like Express, CORS, and dotenv, so you can jump right into development.
--- ## 📜 Table of Contents - [About](#about) - [Installation](#installation) - [Getting Started](#getting-started) - [Features](#features) - [Usage](#usage) - [Contributing](#contributing) - [License](#license) --- ## 💡 About **Banah JS** is a CLI tool designed to scaffold a fully functional Node.js project with just one command. No need to manually install and configure essential dependencies—Banah JS takes care of everything, including creating an initial project structure, a `package.json` file, and commonly used boilerplate code. --- ## ⚙️ Installation Install Banah JS globally using npm: ```bash npm install -g banah ``` --- ## 🚀 Getting Started To create a new Node.js project, run the following command: ```bash banah create your-project-name ``` This will: 1. Create a folder named `your-project-name`. 2. Generate a pre-configured project structure. 3. Install essential dependencies like `express`, `cors`, `dotenv`, and development tools like `nodemon`. Once the setup is complete, navigate to your project folder: ```bash cd your-project-name ``` --- ## ✨ Features - **Express.js**: A lightweight and fast web framework for server-side logic. - **CORS**: Simplifies handling of cross-origin requests. - **dotenv**: Makes managing environment variables easy and secure. - **Nodemon**: Automatically restarts the server during development whenever you save changes. - **Pre-configured Project Structure**: Start coding right away without worrying about boilerplate setup. - **Readable Code**: Clean and modular project code to help beginners understand Node.js. --- ## 🛠️ Usage ### Start the Application To start the server: ```bash npm run start ``` ### Development Mode Run the server in development mode with automatic restarts: ```bash npm run server ``` The server will be available at `http://localhost:3000` by default. --- ## 🧑🤝🧑 Contributing Contributions are welcome! Follow these steps to contribute: 1. Fork this repository. 2. Create a new branch for your feature or fix: ```bash git checkout -b feature/YourFeature ``` 3. Make your changes and commit them: ```bash git commit -m 'Add YourFeature' ``` 4. Push to your branch: ```bash git push origin feature/YourFeature ``` 5. Open a pull request and provide a detailed description of your changes. --- ## 📄 License This project is licensed under the [MIT License](LICENSE). --- ### 🤝 Connect with Us For questions, feedback, or collaboration, feel free to [open an issue](https://github.com/CodeMaestro-dev/banah.js/issues) on GitHub.