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.
![start-ease](https://private-user-images.githubusercontent.com/99423608/271998327-e7da3f92-4841-49da-bbfc-d42a162a5f37.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjQyOTg5MjAsIm5iZiI6MTcyNDI5ODYyMCwicGF0aCI6Ii85OTQyMzYwOC8yNzE5OTgzMjctZTdkYTNmOTItNDg0MS00OWRhLWJiZmMtZDQyYTE2MmE1ZjM3LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA4MjIlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwODIyVDAzNTAyMFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWM1NTM5Yzg1ZGNhMWNmYWQ4ZjIxNzAzNDZiNGEzMDc3NjY1NGVmZjk1MmI1NjNlOTJmNzRhZWM2YmZlMjAxYjAmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.3T45Oo2HYwuPz9ahgBc7JkG1zL98g7uqSzgJ5wlIYtA)
-
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.
- Forking the Repository
- Setting Up Your Development Environment
- Making Changes
- Running Tests
- Creating Pull Requests
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).
Click the "Fork" button at the top-right of the StartEase repository to create a copy of the repository in your GitHub account.
-
Clone your forked repository to your local machine:
git clone https://github.com/JC-Coder/startease.git
-
Change to the project directory:
cd startease
-
Install project dependencies:
npm install
or
yarn install
-
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:
-
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.
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.