StartEase is a command-line interface (CLI) tool designed to make project setup a breeze. Whether you're working with your favorite technologies or exploring new ones, StartEase is your companion for quickly and effortlessly scaffolding projects.

• Effortless Scaffolding: StartEase streamlines project creation and technology scaffolding, providing a smooth and efficient experience for developers.

• Tech Stack Freedom: With StartEase, you have the freedom to choose and set up projects with your preferred technologies.

You can install StartEase using either npm or yarn. Choose your preferred package manager:

Using npm:

npm install -g startease-cli

Using yarn:

yarn global add startease-cli

To start using StartEase, run the following command in your terminal:

startease-cli

This command will launch StartEase and guide you through the project setup process with easy-to-follow prompts.

That's it! StartEase simplifies project setup so you can focus on your development tasks.

The following project templates are available:

• Frontend:

  • React App (Javascript / TypeScript)
  • Vue.js App
  • Angular App
  • HTML/CSS/JavaScript Template

• Backend:

  • Express.js Server
  • Nest.js Server
  • Django Web App
  • Ruby on Rails API
  • Flask API

• Full Stack:

  • MERN Stack App
  • MEAN Stack App
  • Django + React App
  • Ruby on Rails + Vue.js App

The Project Starter Tool supports the following databases:

• PostgreSQL
• MySQL
• MongoDB
• SQLite

We appreciate your interest in contributing to our project. Whether you want to report a bug, suggest an enhancement, or contribute code, these guidelines will help you get started.

1. How Can I Contribute?

• Reporting Bugs
• Suggesting Enhancements
• Contributing Code

2. Getting Started

• Forking the Repository
• Setting Up Your Development Environment
• Making Changes
• Running Tests
• Creating Pull Requests

3. License

If you encounter a bug or unexpected behavior in StartEase, please open an issue and provide the following information:

• A clear and descriptive title.
• A detailed description of the bug, including steps to reproduce it.
• Information about your environment (e.g., operating system, Node.js version).
• Any relevant screenshots or error messages.

We welcome suggestions for new features or improvements. To suggest an enhancement, open an issue with the following details:

• A clear and concise title.
• A detailed description of the enhancement or feature request.
• Any relevant context or examples that help explain the suggestion.

We appreciate contributions that enhance StartEase. To contribute code:

1. Fork the repository.
2. Create a branch for your changes.
3. Make your code changes and commit them with clear messages.
4. Submit a pull request (PR).

Click the "Fork" button at the top-right of the StartEase repository to create a copy of the repository in your GitHub account.

1. Clone your forked repository to your local machine:

   git clone https://github.com/JC-Coder/startease.git

2. Change to the project directory:

   cd startease

3. Install project dependencies:

   npm install

   or

   yarn install

1. Create a new branch for your changes:

   git checkout -b my-feature-branch

Before submitting your changes, test your changes to ensure it's working as expected. and also test other features to ensure nothing breaks.

When you're ready to submit your changes:

1. Commit your changes with a descriptive commit message.

2. Push your changes to your forked repository:

   git push origin my-feature-branch

3. Visit the StartEase repository on GitHub.

4. Click the "New Pull Request" button and follow the prompts.

We'll review your pull request as soon as possible.

Note: Pull requests are to be made against the dev branch.

By contributing to StartEase, you agree that your contributions will be licensed under the MIT License.