Merge branch 'main' into feature/vitest-test-suite

Author: barrymun

.github/workflows/consolidate-snippets.yml

@@ -24,3 +24,7 @@ coverage
 *.njsproj
 *.sln
 *.sw?
+
+# Consolidated snippets
+public/consolidated
+public/icons

.gitignore

@@ -7,6 +7,5 @@
   "bracketSpacing": true,
   "bracketSameLine": false,
   "arrowParens": "always",
-  "endOfLine": "lf",
   "jsxSingleQuote": false
 }

.prettierrc

@@ -65,7 +65,7 @@ If your function doesn't return anything just show how to use it. If the result
 
 To ensure your snippet isn’t refused, consider these questions:
 - **Does the standard library of my language provide an easy way of doing this ?**
-- **Does that snippet have a real, and practical use case ?**
+- **Does that snippet not have a real, and practical use case ?**
 - **Could it be split into separate parts to be better understood ?**
 
 If any answer is yes, then your snippet will most likely get rejected.
@@ -141,11 +141,11 @@ console.log(formatDate(new Date())); // Output: '2024-12-10'
         It will return nothing if they are well formatted, otherwise it will tell you what the error is.
 
         ---
-        To preview the snippets, you need to consolidate them, use the `snippets:consolidate` script:
+        To preview the snippets, start the vite server using:
         ```
-        $ npm run snippets:consolidate
+        $ npm run dev
         ```
-        It will update the snippets in the `/public` folder, making them available to the frontend.
+        It will use HMR to update the snippets in the `/public` folder, making them available to the frontend.
 
 Expected file structure:
 

CONTRIBUTING.md

@@ -1,3 +1,55 @@
 # Vision for QuickSnip
 
-Will be updating soon...
+## What is QuickSnip?
+
+QuickSnip is an open-source tool designed for developers who want to organize, search, and share code snippets. It aims to streamline the coding process by providing a centralized platform for snippet management.
+
+## Core Principles
+
+- **Developer Focused**: Focus on features that truly improve developer productivity.
+
+- **Open and Extensible**: Encourage community contributions and integrations.
+
+- **Lightweight and Fast**: Keep performance high and avoid unnecessary complexity.
+
+## Our Goals
+
+- Seamless snippet management without turning into an overly complex tool
+
+- Enable collaboration and sharing while respecting user privacy and customization needs.
+
+We do **NOT** aim to be:
+
+- a component library
+- a documentation 
+
+## QuickSnip Roadmap
+
+### v1.0 (Launching Soon)
+
+- [x] A new snippets storage system for better maintainability and scalability
+- [ ] Search functionality
+- [ ] A support for frameworks and libraries
+- [ ] An ability to share snippets with others
+- [ ] A basic SEO (Search Engine Optimization)
+
+### v2.0 (Planned Vision)
+
+- [ ] An ability to have private snippets with personal account
+- [ ] Improved search functionality with filters
+- [ ] An improved SEO (Search Engine Optimization)
+
+### Potential Future Ideas
+
+- [ ] Plugins for IDEs like VS Code and JetBrains
+- [ ] Enterprise-grade support for larger organizations
+
+## Disclaimer on Future Plans
+
+This roadmap outlines our current vision for QuickSnip and may evolve based on user feedback, community contributions, and shifting priorities. We welcome your input and encourage you to help shape QuickSnip’s future.
+
+## Future Vision
+
+QuickSnip aims to become the preferred platform for developers to store, retrieve, and collaborate on code snippets.
+
+Explore our [GitHub Releases](https://github.com/dostonnabotov/quicksnip/releases) for updates and join us on this journey.