CodeGlimpse is an online platform that allows users to easily share and manage code snippets. It offers the convenience of making snippets private by adding a passcode for added security. Users can quickly log in and sign up using their Google account with just one click, giving them access to their code snippets stored in their personal library.
- Frontend: CodeGlimpse is built using React for the user interface and Tailwind CSS for styling, ensuring a responsive and visually appealing design.
- Backend: The backend of CodeGlimpse is powered by Python, utilizing the FAST API framework. We've chosen PostgreSQL as our database management system, and we interact with it using the SQLAlchemy ORM for seamless database operations.
- Code Sharing: Users can easily paste and share code snippets with others, making collaboration and knowledge sharing a breeze.
- Privacy: CodeGlimpse allows users to set a passcode for their snippets, keeping them private and secure.
- One-Click Google Login: We provide a seamless login experience with one-click Google authentication, simplifying user access to their personal code library.
This is basically the Frontend repo for the project, you can find the source code for the backend here at Codeglimpse Backend
To run CodeGlimpse locally, follow these simple steps:
-
Clone this repository to your local machine.
-
Install the required dependencies for both the frontend and backend:
cd Codeglimpse-API
pip install -r requirements.txt
cd Codeglimpse
npm install
-
Configure the database connection in the backend settings.
-
Start the frontend and backend servers:
-
cd frontend npm start
uvicorn main:app --reload
-
The Python app will be started at
http://127.0.0.1:5173
and you can test the APIs on Postman -
The React app will be started at
http://127.0.0.1:8000
and you can access it by opening your web browser and navigating tohttp://127.0.0.1:5173
We welcome contributions from the community! If you have ideas for improvements or would like to report any issues, please feel free to create a GitHub issue or submit a pull request.
CodeGlimpse is open-source software released under the MIT License. You are free to use, modify, and distribute this software as per the terms of the license.
Enjoy sharing and managing your code snippets with CodeGlimpse!