https://github.com/roerohan/csi-webapp-template
A Command Line Interface to Generate templates for WebApps.
https://github.com/roerohan/csi-webapp-template
Last synced: 4 months ago
JSON representation
A Command Line Interface to Generate templates for WebApps.
- Host: GitHub
- URL: https://github.com/roerohan/csi-webapp-template
- Owner: roerohan
- License: lgpl-3.0
- Created: 2019-05-12T12:01:19.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-07T14:39:48.000Z (over 6 years ago)
- Last Synced: 2025-06-07T10:48:43.310Z (12 months ago)
- Language: HTML
- Homepage:
- Size: 3.97 MB
- Stars: 1
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# CSI-WebApp-Template (csi-cli)
```
██████╗███████╗██╗ ██████╗██╗ ██╗
██╔════╝██╔════╝██║ ██╔════╝██║ ██║
██║ ███████╗██║█████╗██║ ██║ ██║
██║ ╚════██║██║╚════╝██║ ██║ ██║
╚██████╗███████║██║ ╚██████╗███████╗██║
╚═════╝╚══════╝╚═╝ ╚═════╝╚══════╝╚═╝
```
The CSI-WebApp-Template is a CLI tool which helps you generate a Node-js or Django template for a Website with features such as:-
- Connect to Database
- Basic User Model
- Add User (with hashed password)
- User Login/Logout
- Admin Login/Logout
- Admin Panel - Add, Update, Delete User
- Authentication with Sessions
- Required HTML Pages linked with CSS
## Table Of Contents
1. [Installation](#installation)
* [For Windows](#for-windows)
* [For Unix Like OS](#for-unix-based-os)
2. [Requirements](#requirements)
* [For Node-js Template](#for-node-js-template)
* [For Django Template](#for-django-template)
3. [Usage](#usage)
4. [Contributing](#contributing)
5. [License](#license)
## Installation
The CSI-WebApp-Template CLI can be installed for both Windows and Unix-based Operating Systems.
### For Windows
```bash
#TODO
```
### For Unix-Based OS
```bash
sh -c "$(curl -fsSL https://raw.githubusercontent.com/csivitu/CSI-WebApp-Template/master/Unix/tools/install.sh)"
```
#### OR
```bash
git clone https://github.com/csivitu/CSI-WebApp-Template.git ~/CSI-WebApp-Template
cd .CSI-WebApp-Template
./Unix/tools/install.sh
```
## Requirements
> For Unix Based OS, ~/.local/bin must be added to PATH.
### For Node-js Template
- Node-js (with npm)
- MongoDB
### For Django Template
- Python 3.6+ (with pip)
- Django: Do - pip install django
## Usage
- Create a directory having the name of the Project
- Run the command: csi-cli gen -n your-project-name OR csi-cli gen -d your-project-name
#### The following are the commands that our CLI supports.
```bash
csi-cli {-h --help}: Help
csi-cli {-v --version}: Version
csi-cli {gen generate} {-n --node} your-project-name: Generate Node-js Template
{-d --django} your-project-name: Generate Django Template
csi-cli {-D --delete} your-project-name: Delete Project
csi-cli {-r --reset}: Reset All Changes Made to Template
csi-cli {-u --update}: Updates the csi-cli
```
In absence of project-name, csi-cli assumes you are in the project directory.
## Contributing
- For Contributing to csi-cli, refer to [CONTRIBUTING.md](https://github.com/csivitu/CSI-WebApp-Template/blob/master/CONTRIBUTING.md).
## License
- [LICENSE](https://github.com/csivitu/CSI-WebApp-Template/blob/master/LICENSE)