diff --git a/CHANGELOG.md b/CHANGELOG.md index df58861..ff3694d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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. diff --git a/README.md b/README.md index 27def70..e348089 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,80 @@ -# Flutter Boilerplate - Your Swiss Army Knife for Flutter Projects +

+ Startify Logo +

+# 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!" ๐Ÿ˜„๐Ÿš€ diff --git a/assets/logo.png b/assets/logo.png new file mode 100644 index 0000000..f11fd78 Binary files /dev/null and b/assets/logo.png differ diff --git a/extension.js b/extension.js index f72d28e..ab55ff5 100644 --- a/extension.js +++ b/extension.js @@ -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(); }); diff --git a/package.json b/package.json index 926e5a4..0583cf8 100644 --- a/package.json +++ b/package.json @@ -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" @@ -21,8 +21,8 @@ "contributes": { "commands": [ { - "command": "flutter-boilerplate-generator.generateFiles", - "title": "Generate Boilerplate" + "command": "startify.initiate", + "title": "Startify: Generate Flutter Boilerplate" } ] },