Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit e0c04f2

Browse files
committed
Merge branch 'main' into feature/vitest-test-suite
2 parents 5dcad06 + 93ccb16 commit e0c04f2

File tree

118 files changed

+3116
-2880
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+3116
-2880
lines changed

‎.github/workflows/consolidate-snippets.yml‎

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,7 @@ coverage
2424
*.njsproj
2525
*.sln
2626
*.sw?
27+
28+
# Consolidated snippets
29+
public/consolidated
30+
public/icons

‎.prettierrc‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,5 @@
77
"bracketSpacing": true,
88
"bracketSameLine": false,
99
"arrowParens": "always",
10-
"endOfLine": "lf",
1110
"jsxSingleQuote": false
1211
}

‎CONTRIBUTING.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ If your function doesn't return anything just show how to use it. If the result
6565

6666
To ensure your snippet isn’t refused, consider these questions:
6767
- **Does the standard library of my language provide an easy way of doing this ?**
68-
- **Does that snippet have a real, and practical use case ?**
68+
- **Does that snippet not have a real, and practical use case ?**
6969
- **Could it be split into separate parts to be better understood ?**
7070

7171
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日'
141141
It will return nothing if they are well formatted, otherwise it will tell you what the error is.
142142
143143
---
144-
To preview the snippets, you need to consolidate them, use the `snippets:consolidate` script:
144+
To preview the snippets, start the vite server using:
145145
```
146-
$ npm run snippets:consolidate
146+
$ npm run dev
147147
```
148-
It will update the snippets in the `/public` folder, making them available to the frontend.
148+
It will use HMR to update the snippets in the `/public` folder, making them available to the frontend.
149149
150150
Expected file structure:
151151

‎VISION.md‎

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,55 @@
11
# Vision for QuickSnip
22

3-
Will be updating soon...
3+
## What is QuickSnip?
4+
5+
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.
6+
7+
## Core Principles
8+
9+
- **Developer Focused**: Focus on features that truly improve developer productivity.
10+
11+
- **Open and Extensible**: Encourage community contributions and integrations.
12+
13+
- **Lightweight and Fast**: Keep performance high and avoid unnecessary complexity.
14+
15+
## Our Goals
16+
17+
- Seamless snippet management without turning into an overly complex tool
18+
19+
- Enable collaboration and sharing while respecting user privacy and customization needs.
20+
21+
We do **NOT** aim to be:
22+
23+
- a component library
24+
- a documentation
25+
26+
## QuickSnip Roadmap
27+
28+
### v1.0 (Launching Soon)
29+
30+
- [x] A new snippets storage system for better maintainability and scalability
31+
- [ ] Search functionality
32+
- [ ] A support for frameworks and libraries
33+
- [ ] An ability to share snippets with others
34+
- [ ] A basic SEO (Search Engine Optimization)
35+
36+
### v2.0 (Planned Vision)
37+
38+
- [ ] An ability to have private snippets with personal account
39+
- [ ] Improved search functionality with filters
40+
- [ ] An improved SEO (Search Engine Optimization)
41+
42+
### Potential Future Ideas
43+
44+
- [ ] Plugins for IDEs like VS Code and JetBrains
45+
- [ ] Enterprise-grade support for larger organizations
46+
47+
## Disclaimer on Future Plans
48+
49+
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.
50+
51+
## Future Vision
52+
53+
QuickSnip aims to become the preferred platform for developers to store, retrieve, and collaborate on code snippets.
54+
55+
Explore our [GitHub Releases](https://github.com/dostonnabotov/quicksnip/releases) for updates and join us on this journey.

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /