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
   • For Windows
   • For Unix Like OS
2. Requirements
   • For Node-js Template
   • For Django Template
3. Usage
4. Contributing
5. License

Installation

The CSI-WebApp-Template CLI can be installed for both Windows and Unix-based Operating Systems.

For Windows

#TODO

For Unix-Based OS

sh -c "$(curl -fsSL https://raw.githubusercontent.com/csivitu/CSI-WebApp-Template/master/Unix/tools/install.sh)"

OR

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.

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.

License

• LICENSE