excela
v1.0.4
Published
Excela is a CLI tool designed to simplify project setup. It helps you quickly set up backend, frontend, or fullstack projects like MERN, with options to include TailwindCSS and other essential tools.
Downloads
358
Readme
Excela
Excela is a simple command-line tool to help developers easily set up their projects with a variety of configurations. Whether you're starting a backend, frontend, or full-stack project, Excela simplifies the process by guiding you through the setup of essential tools like TailwindCSS, Vite, and other useful utilities for modern web development.
Features
- Easy Project Setup: Quickly initialize backend, frontend, or full-stack projects.
- MERN Stack Setup: Helps you set up a full MERN (MongoDB, Express, React, Node.js) stack with minimal effort.
- Frontend Setup: Initialize frontend projects using tools like Vite or Create React App.
- TailwindCSS Integration: Optionally include TailwindCSS for modern, responsive UI design.
- Efficient Configuration: Select your preferred tools and technologies during the setup process.
Installation
You can use Excela in two ways:
- Directly via
npx
(no installation required). - By installing it globally or locally with
npm
.
Option 1: Using npx
(Recommended for Quick Use)
Run the following command to use Excela without installation:
npx excela@latest
Option 2: Install Globally or Locally
npm install -g excela
Once installed, you can run the tool using:
excela
npx excela@latest
This command will walk you through setting up a project by asking you a few questions about your preferred tech stack. Based on your choices, it will:
- Set up frontend (with Vite or Create React App).
- Set up backend (Node.js or Express).
- Set up full-stack (MERN stack).
- Optionally include TailwindCSS for frontend styling.
Setup Process
During the initialization, Excela will ask you a few questions to determine the configuration of your project. These include:
- Project Name: The name for your new project.
- Tech Stack Choice: Choose whether you want a backend, frontend, or a full-stack (MERN) setup.
- Frontend Setup:
- Select the build tool: Vite or Create React App.
- Choose the project language: JavaScript or TypeScript.
- Optionally add TailwindCSS for modern CSS styling.
- Backend Setup: Choose whether you want a backend with Express.
Once the choices are made, Excela will create the project structure, install dependencies, and set up configuration files.
Example Usage
After running the following command, you'll be prompted to make selections for your project:
npx excela@latest
Contributing
If you'd like to contribute to Excela, feel free to submit a pull request! Here's how you can contribute:
- Fork the repository.
- Clone your fork locally.
- Create a new branch for your changes.
- Make your changes and commit them.
- Push the changes to your fork.
- Create a pull request from your fork to the main repository.