Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/opeolluwa/thunderstorm
A Command Line Application for automating generation of server applications
https://github.com/opeolluwa/thunderstorm
backend cli devops node open-source
Last synced: about 11 hours ago
JSON representation
A Command Line Application for automating generation of server applications
- Host: GitHub
- URL: https://github.com/opeolluwa/thunderstorm
- Owner: opeolluwa
- License: mit
- Created: 2022-02-12T22:32:53.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T13:21:46.000Z (over 1 year ago)
- Last Synced: 2025-01-11T18:27:28.285Z (25 days ago)
- Topics: backend, cli, devops, node, open-source
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@opeolluwa/thunderstorm
- Size: 484 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# ThunderStorm
A Command Line tool for quickly setting up server-application
## Features
- Simple
- Lightweight
- creates folders using best practice
- initialize project with packages
- ships with `package.json` and eliminates the need for `npm init`
## Installation
Thunderstorm is distributed with `npm` which ships with Node.js, to begin [install Node.js](https://nodejs.org), if you don't have it installed, then run `npm i -g @opeolluwa/thunderstorm`
## Usage/Examples
`thunderstorm` uses `bash` under the hood to execute package installation of application dependencies. Ensure to install `bash` shell before you execute `npm run make` or `yarn make`, depending on your preferred package manager. You could choose to copy the content on `install.sh` instead and execute it in your preferred Command Line Interface (terminal) when the project has been generated
- initialize a new basic project
```bash
$ thunderstorm init
```
- initialize a project with packages
```bash
$ thunderstorm init -p ...
```
- initialize a project with packages and environment variables
```bash
$ thunderstorm init -p ... -e ...
```
- See the initialization guide option
```bash
$ thunderstorm help init
```
-
## Demo
## Run Locally
Clone the project
```bash
git clone https://github.com/opeolluwa/thunderstorm
```
Go to the project directory
```bash
cd thunderstorm
```
Install dependencies
```bash
npm install
```
Start the server
```bash
./index.js
```
## Contributing
Contributions are always welcome!
See `contributing.md` for ways to get started.
Please adhere to this project's `code of conduct`.