NilaJS REST api framework

A command-line tool to quickly scaffold a new project using the Nilajs framework. This tool sets up a project with a predefined structure, including essential configuration files and folders.

Table of Contents

• Features
• Installation
• Usage
• Project Structure
• License

Features

• Quick setup of a new Nilajs project.
• Generates essential configuration files and directories.
• Interactive command-line interface for user inputs.
• Uses ora for spinners and chalk for colored output.

Installation

To install the Nilajs Project Generator globally, run the following command:

npm install -g nilajs

Get started without installation

npx nilajs

Usage

After installing, you can create a new Nilajs project by running:

nilajs 

Follow the prompts to enter your project name, and the generator will create the project structure for you.

Project Structure

Upon successful creation of the project, the following files and folders will be generated:

.
├── .babelrc
├── .env
├── .env.example
├── .gitignore
├── LICENSE
├── babel.config.json
├── package-lock.json
├── package.json
├── src
└── tests

Getting Started

After generating your project, navigate to the project directory and install the necessary dependencies:

cd your-project-name
npm install

To start your application, use:

npm start

License

MIT License

Copyright (c) 2023 Sivabharathy

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.