Skip to content

Commit

Permalink
Renamed project, added logo, updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Atharva Patwardhan committed Dec 12, 2023
1 parent d3eecb7 commit 6e76012
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 34 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log

All notable changes to the "flutter-boilerplate-generator" extension will be documented in this file.
All notable changes to the "startify" extension will be documented in this file.

Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.

Expand Down
69 changes: 41 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,67 +1,80 @@
# Flutter Boilerplate - Your Swiss Army Knife for Flutter Projects
<p align="center">
<img src="assets/logo.png" alt="Startify Logo" width="512" height="512">
</p>

# Startify - Your Swiss Army Knife for Flutter Projects

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Getting Started](#getting-started)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Startify - Your Swiss Army Knife for Flutter Projects](#startify---your-swiss-army-knife-for-flutter-projects)
- [Table of Contents](#table-of-contents)
- [Introduction](#introduction)
- [But Wait, There's More!](#but-wait-theres-more)
- [Features](#features)
- [Getting Started](#getting-started)
- [Contributing](#contributing)
- [License](#license)

## Introduction

Welcome to Flutter Boilerplate, your all-in-one companion for creating awesome Flutter projects with ease! Whether you're starting a new project or need to jump-start development on your next brilliant idea, Flutter Boilerplate has got your back. Say goodbye to tedious repetitive setup tasks and hello to a smooth, delightful development experience.
Welcome to Startify, your all-in-one companion for creating awesome Flutter projects with ease! Whether you're starting a new project or need to jump-start development on your next brilliant idea, Startify has got your back. Say goodbye to tedious repetitive setup tasks and hello to a smooth, delightful development experience.

### But Wait, There's More!

Flutter Boilerplate isn't just another mundane extension. It's a Swiss Army Knife for Flutter projects! We've assembled a collection of useful tools and utilities inside the `utils`, `providers`, and `widgets` folders, so you can focus on building incredible apps rather than wasting time on boilerplate code.
Startify isn't just another mundane extension. It's a Swiss Army Knife for Flutter projects! We've assembled a collection of useful tools and utilities inside the `utils` and `services` folder, so you can focus on building incredible apps rather than wasting time on boilerplate code.

## Features

- **utils** folder:
- 🧵 **Strings File**: Automatically generate a strings file with commonly used strings.
- 🎨 **Colors File**: Create an app colors file to keep your palette in perfect harmony.
- 📱 **Responsive Layout**: Get a head start with a layout builder widget for multiple screen sizes.
- 📦 **Constants**: Store your constant functions and variables in one convenient file.
- 💅 **Styles**: Organize your textstyles, buttonstyles, and more in a dedicated styles file.
- 🖼️ **Assets**: Easily manage your image and SVG asset paths.
- **Shared Preferences Helper:**
- *File:* `lib/utils/services/shared_preferences_helper.dart`
- *Description:* Utility class for handling shared preferences with most commonly used shared preferences methods.

- **providers** folder:
- 🤝 **Common Provider Boilerplate**: Kickstart your app's state management with ease.
- **Assets Utility:**
- *File:* `lib/utils/assets.dart`
- *Description:* Utility class for defining asset paths like images, svgs, gifs, etc.

- **widgets** folder:
- 🚀 **AppBar Widget**: Quickly generate an AppBar widget for your Flutter app.
- **Colors Utility:**
- *File:* `lib/utils/colors.dart`
- *Description:* Utility class for defining colors to be used throughout the app.

- **Constants Utility:**
- *File:* `lib/utils/constants.dart`
- *Description:* Utility class with constantly used variables/extensions/utility methods (includes some prethrown good stuff 😉).

- **Responsive Widget:**
- *File:* `lib/utils/responsive.dart`
- *Description:* A responsive widget for handling different screen sizes.

- **Styles Utility:**
- *File:* `lib/utils/styles.dart`
- *Description:* Utility class for defining text styles and input decorations.

- **screens** folder:
- 🏠 **Homepage Widget**: Enjoy a ready-to-use homepage stateful widget for quick development.

## Getting Started

Flutter Boilerplate is easy to install and use. Here's how you can get started:
Startify is easy to install and use. Here's how you can get started:

1. Install the Extension:
- Open Visual Studio Code.
- Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on Mac).
- Search for "Flutter Boilerplate" and click "Install."
- Search for "Startify" and click "Install."

2. Run the Command:
- Open your Flutter project in Visual Studio Code.
- Make sure that the lib folder has been generated (crucial step)
- Press `F1` (or `Ctrl+Shift+P` / `Cmd+Shift+P` on Mac) to open the Command Palette.
- Type "Generate Boilerplate" and select the command when it appears in the list.
- Type "Startify: Generate Startify" and select the command when it appears in the list.

That's it! The extension will work its magic, generating the necessary files and folders inside the `lib` folder of your Flutter project, including the `utils`, `providers`, `widgets`, and `screens` folders with the corresponding boilerplate code.

## Contributing

We welcome all contributions to make Flutter Boilerplate even more fantastic! If you have an idea for a new feature or find a bug, head over to our [GitHub repository](https://github.com/CodeSadhu/boilerplate-vscode) and let us know. We encourage you to be creative, innovative, and humorous in your contributions (just like this README!).
We welcome all contributions to make Startify even more fantastic! If you have an idea for a new feature or find a bug, head over to our [GitHub repository](https://github.com/CodeSadhu/startify) and let us know. We encourage you to be creative, innovative, and humorous in your contributions (just like this README!).

## License

Flutter Boilerplate is released under the [MIT License](https://opensource.org/licenses/MIT), which means you can use it freely in your projects without any worries.
Startify is released under the [MIT License](https://opensource.org/licenses/MIT), which means you can use it freely in your projects without any worries.

---

We hope you find Flutter Boilerplate as delightful to use as we found it delightful to build! Happy coding, and remember, "Boilerplates don't have to be boring!" 😄🚀
We hope you find Startify as delightful to use as we found it delightful to build! Happy coding, and remember, "Boilerplates don't have to be boring!" 😄🚀
Binary file added assets/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion extension.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ const path = require('path');

function activate(context) {
// Register the command
let disposable = vscode.commands.registerCommand('flutter-boilerplate-generator.generateFiles', () => {
let disposable = vscode.commands.registerCommand('startify.initiate', () => {
generateFiles();
});

Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"name": "flutter-boilerplate-generator",
"name": "startify",
"displayName": "Flutter Boilerplate Generator",
"description": "Generate boilerplate files and folders for new Flutter projects.",
"version": "1.0.0",
"repository": {
"type": "git",
"url": "git://github.com/CodeSadhu/boilerplate-vscode.git"
"url": "https://github.com/CodeSadhu/boilerplate-vscode.git"
},
"engines": {
"vscode": "^1.80.0"
Expand All @@ -21,8 +21,8 @@
"contributes": {
"commands": [
{
"command": "flutter-boilerplate-generator.generateFiles",
"title": "Generate Boilerplate"
"command": "startify.initiate",
"title": "Startify: Generate Flutter Boilerplate"
}
]
},
Expand Down

0 comments on commit 6e76012

Please sign in to comment.