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
yarn. Choose your preferred package manager:
npm install -g startease-cli
yarn global add startease-cli
To start using StartEase, run the following command in your terminal:
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:
- React App
- Vue.js App
- Angular App
- Express.js Server
- Nest.js Server
- Django Web App
- Ruby on Rails API
- Flask API
- MERN Stack App
- MEAN Stack App
- Django + React App
- Ruby on Rails + Vue.js App
The Project Starter Tool supports the following databases:
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.
Table of Contents
- Forking the Repository
- Setting Up Your Development Environment
- Making Changes
- Running Tests
- Creating Pull Requests
How Can I Contribute?
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:
- Fork the repository.
- Create a branch for your changes.
- Make your code changes and commit them with clear messages.
- Submit a pull request (PR).
Forking the Repository
Click the “Fork” button at the top-right of the StartEase repository to create a copy of the repository in your GitHub account.
Setting Up Your Development Environment
Clone your forked repository to your local machine:
git clone https://github.com/JC-Coder/startease.git
Change to the project directory:
Install project dependencies:
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.
Creating Pull Requests
When you’re ready to submit your changes:
Commit your changes with a descriptive commit message.
Push your changes to your forked repository:
git push origin my-feature-branch
Visit the StartEase repository on GitHub.
Click the “New Pull Request” button and follow the prompts.
We’ll review your pull request as soon as possible.
By contributing to StartEase, you agree that your contributions will be licensed under the MIT License.