Skip to content

Commit 32f7e05

Browse files
feat: add MIT License file and update README for project clarity
1 parent 630bdde commit 32f7e05

File tree

2 files changed

+26
-62
lines changed

2 files changed

+26
-62
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Muhammad Talha Bilal
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE

readme.md

Lines changed: 5 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,7 @@
1-
# create-node-spark
1+
# 🚀 create-node-spark
22

3-
A CLI tool to scaffold a basic Node.js + Express backend. This open-source tool simplifies the setup of a Node.js project with optional features such as authentication and file uploads using Multer.
4-
5-
## Usage
6-
7-
```bash
8-
npx create-node-spark
9-
```
10-
11-
## Features
12-
13-
- **Optional Authentication**: Seamlessly integrates argon2 and JWT for user authentication.
14-
- **Multer Integration**: Easily add file upload capabilities.
15-
- **Quick Setup**: Scaffolds a ready-to-use Node.js project in seconds.
16-
17-
## Installation
18-
19-
To install and use the CLI tool locally, follow these steps:
20-
21-
1. Clone the repository:
22-
```bash
23-
git clone https://github.com/talhabilal-dev/create-node-spark.git
24-
cd create-node-spark
25-
```
26-
27-
2. Link the package globally:
28-
```bash
29-
npm link
30-
```
31-
32-
3. Run the CLI tool:
33-
```bash
34-
create-node-spark
35-
```
36-
37-
## Getting Started
38-
39-
1. **Run the CLI**: Execute the command `create-node-spark` and follow the prompts. You can choose to include authentication and file upload functionalities.
40-
41-
2. **Navigate to Your Project**: After generation, move into your new project directory:
42-
```bash
43-
cd your-project-name
44-
```
45-
46-
3. **Start the Development Server**: Use Node.js to run the server:
47-
```bash
48-
npm run dev
49-
```
50-
51-
## Contributing
52-
53-
Contributions are welcome! If you have suggestions for improvements or new features, feel free to submit a pull request or open an issue.
54-
55-
## License
56-
57-
This project is licensed under the MIT License.
58-
59-
---
60-
61-
### Future Enhancements
62-
63-
We are considering adding a **template system** to automatically generate folders such as `/routes`, `/controllers`, and `/middlewares`. If you have any ideas or requests, let us know! 🌟
3+
**The fastest way to scaffold production-ready Node.js backends — no manual setup, no headaches.**
644

5+
![npm](https://img.shields.io/npm/v/create-node-spark)
6+
![GitHub stars](https://img.shields.io/github/stars/talhabilal-dev/create-node-spark)
7+
![License](https://img.shields.io/github/license/talhabilal-dev/create-node-spark)

0 commit comments

Comments
 (0)