CodeCandy is a modern web application designed for developers to manage and share code snippets efficiently. With its sleek, responsive UI, dark theme support, and offline capabilities, CodeCandy provides a seamless experience for organizing your code, regardless of where you are.
- Code Management: Create, edit, delete, and organize snippets in collections.
- User Experience: Dark theme, responsive design, and keyboard shortcuts.
- Data Handling: Online/offline support, real-time updates, and secure data access.
- Authentication: Google with protected routes.
- Performance: Optimized animations, caching, and lazy loading for blazing-fast performance.
Follow these steps to get CodeCandy running on your local machine:
- Node.js (v18 or later)
- npm or yarn
- Firebase project configuration
-
Clone the Repository:
git clone https://github.com/your-username/codecandy.git cd codecandy -
Install Dependencies:
npm install # or yarn install -
Setup Firebase Configuration:
- Create a
.envfile in the root directory. - Add your Firebase configuration:
VITE_FIREBASE_API_KEY=your-api-key VITE_FIREBASE_AUTH_DOMAIN=your-auth-domain VITE_FIREBASE_PROJECT_ID=your-project-id VITE_FIREBASE_STORAGE_BUCKET=your-storage-bucket VITE_FIREBASE_MESSAGING_SENDER_ID=your-sender-id VITE_FIREBASE_APP_ID=your-app-id
- Create a
-
Start the Development Server:
npm run dev # or yarn devOpen your browser and navigate to http://localhost:3000.
We welcome contributions to CodeCandy! To contribute:
-
Fork the Repository: Click the "Fork" button on the top right of this repository.
-
Create a Branch:
git checkout -b feature/your-feature-name
-
Commit Your Changes: Ensure your code follows the existing style and guidelines.
git add . git commit -m "Add your commit message"
-
Push Your Branch:
git push origin feature/your-feature-name
-
Submit a Pull Request: Go to the repository on GitHub and open a pull request. Include a clear description of the changes made.
This project is licensed under the MIT License. See the LICENSE file for details.
Enjoy using CodeCandy and feel free to contribute to its growth! 🌟
