https://github.com/meeruzairwashere/ezsnippets
Your hassle-free solution for developers to organize, store, and access code snippets efficiently, enhancing productivity and focus in the development workflow.
https://github.com/meeruzairwashere/ezsnippets
mongodb mongoose nextjs14 react-hook-form react-query server-actions serverless shadcn-ui typescript zod
Last synced: 2 months ago
JSON representation
Your hassle-free solution for developers to organize, store, and access code snippets efficiently, enhancing productivity and focus in the development workflow.
- Host: GitHub
- URL: https://github.com/meeruzairwashere/ezsnippets
- Owner: MeerUzairWasHere
- Created: 2024-01-21T14:51:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-14T19:36:29.000Z (5 months ago)
- Last Synced: 2025-04-28T13:29:08.970Z (2 months ago)
- Topics: mongodb, mongoose, nextjs14, react-hook-form, react-query, server-actions, serverless, shadcn-ui, typescript, zod
- Language: TypeScript
- Homepage: https://ezsnippets.vercel.app
- Size: 810 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ezSnippets
Code, Organize, Access.
Explore the docs »
View Demo
.
Report Bug
.
Request Feature
     
## Table Of Contents
* [About the Project](#about-the-project)
* [Built With](#built-with)
* [Getting Started](#getting-started)
* [Usage](#usage)
* [Roadmap](#roadmap)
* [Contributing](#contributing)
* [License](#license)
* [Authors](#authors)
* [Acknowledgements](#acknowledgements)
## About The Project
ezSnippets is a powerful web application designed to simplify code snippet management for developers of all levels. Our mission is to provide a seamless and efficient solution for organizing and accessing code snippets, ultimately enhancing productivity and streamlining the development workflow.
## Built With
e constructed ezSnippets using a robust combination of frameworks and tools to ensure a seamless experience for our users:
- **Frontend**: Next.js powers the frontend user interface, providing flexibility and performance.
- **Backend**: Mongoose and MongoDB handle efficient data storage and management, ensuring reliability and scalability.
- **Authentication**: Clerk streamlines user authentication and management, prioritizing security and ease of use.
- **UI Design**: TailwindCSS, along with either Shadcn-ui, enables customizable and visually appealing user interfaces.
These frameworks and tools form the foundation of ezSnippets, empowering developers to organize and access their code snippets with ease while ensuring a delightful user experience.
## Getting Started
## Installation Instructions
To install and set up ezSnippets locally, follow these steps carefully:
### Prerequisites
Ensure you have the following installed on your local machine:
- Node.js
- MongoDB
### Installation Steps
1. Clone the repository to your local machine:
```bash
git clone https://github.com/your-username/ezSnippets.git
```
2. Navigate to the project directory:
```bash
cd ezSnippets
```
3. Install dependencies using npm:
```bash
npm install
```
### Configuration
1. Set up your MongoDB database and obtain the connection URI.
2. Create a `.env` file in the root directory of the project.
3. Add the following environment variables to your `.env` file:
```
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_bGl0ZXJhdGUtYmFiasdasdasdasdmFjY291bnRzLmRldiQ
CLERK_SECRET_KEY=sk_test_n7Ym4r2mbLw3LasdasdasdasdasWrVbpbl9ort
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/snippets
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/snippets
MONGODB_URI=mongodb+srv://username:password@your-mongodb-uri/ezSnippets?retryWrites=true&w=majority
```
Replace `your-mongodb-uri`, `username`, and `password` with your MongoDB connection URI credentials.
### Running the Application
1. Start the development server:
```bash
npm run dev
```
2. Access ezSnippets in your browser at `http://localhost:3000`.
### That's it!
You have successfully installed and configured ezSnippets locally on your machine. Start organizing your code snippets effortlessly! 🚀
## Usage
### Examples of ezSnippets Usage
#### 1. User Registration and Login
Easily register and log in to your ezSnippets account using Clerk authentication. Seamlessly manage your code snippets with secure access.
#### 2. Code Snippet Management
Effortlessly save, categorize, and retrieve your code snippets with ezSnippets. Add descriptive tags for easy organization and quick access during development.
#### 3. Clipboard Integration
Integrate ezSnippets with your clipboard for efficient code reuse. Swiftly copy code snippets to use in your projects without interrupting your workflow.
#### 4. Responsive Design
Enjoy a seamless experience across different devices and screen sizes with ezSnippets' responsive design. Access your code snippets anytime, anywhere.
## Roadmap
See the [open issues](https://github.com/MeerUzairWasHere/ezSnippets/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/MeerUzairWasHere/ezSnippets/issues/new) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
* Please make sure you check your spelling and grammar.
* Create individual PR for each suggestion.
* Please also read through the [Code Of Conduct](https://github.com/MeerUzairWasHere/ezSnippets/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.
### Creating A Pull Request
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See [LICENSE](https://github.com/MeerUzairWasHere/ezSnippets/blob/main/LICENSE.md) for more information.