satmm / clippy Goto Github PK

Event Logo	Event Name	Event Description
	GirlScript Summer of Code 2024	GirlScript Summer of Code is a three-month-long Open Source Program conducted every summer by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development.

• Usage
• Screenshots
• Features
• Setup Instructions
  • Installation
  • Set Up Environment Variables
  • Run the Development Server
  • Dockerfile
• Contributing
  • Contributing Guidelines
• Documentation
• Join Us
• Our Contributors

Clippy is publically available and hosted on Vercel, you can access Clippy here

Homepage

Making a Clippy

• Clipboard Management: Easily copy and paste text snippets with Clippy.
• File Sharing: Share files effortlessly using Clippy's file sharing feature.
• Secure Storage: Clippy uses MongoDB for secure storage of your clippings and files.

To get started with this project, follow these steps:

1. Clone this repository:

git clone <link>

2. Navigate to the Project Directory:

cd <filename>

Install the dependencies using your preferred package manager. For example, if you're using npm:

npm install

This project requires environment variables for MongoDB connection. Create a .env file in the root directory of the project and add the following variables:

MONGODB_URI=<your_mongodb_uri>
MONGO_DB_NAME=<your_db_name>
MONGO_COLLECTION_NAME=<your_collection_name>

Once you have installed the dependencies and set up the environment variables, you can start the development server by running:

npm run dev

Make sure you have docker & docker compose installed on the server / system. Both are installed by most docker utilities, including Docker Desktop and Rancher Desktop.

Note: docker compose without the hyphen is now the primary method of using docker-compose, per the Docker documentation. we have a demo dockerfile make sure u have a .dockerignore file in the root directory of the project. add following lines into it

node_modules

now run the image with injecting the env variables into the docker itself

docker build -t clippy .
docker run -p 3000:3000 -e MONGODB_URI=<your_mongodb_uri> -e MONGO_DB_NAME=<your_db_name> -e MONGO_COLLECTION_NAME=<your_collection_name> clippy

If you'd like to contribute to this project, feel free to open an issue or submit a pull request. Contributions are welcome! , please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make changes and commit them.
4. Push your changes to your fork.
5. Create a pull request.

We believe in the power of collaboration. If you have ideas to improve College.ai, feel free to contribute! Check out our Contribution Guidelines to get started.

Explore our comprehensive documentation in the LEARN.md file, which serves as a detailed guide to understanding and contributing to Clippy. This document covers various aspects of the project, including setup instructions, architecture overview, and contribution guidelines. We recommend referring to this documentation to gain a deeper insight into UniCollab and make meaningful contributions to its development.

Ready to embark on a journey of collaborative learning? Join Clippy now and be a part of a community that believes in the power of collaboration! Thank you for contributing to our open-source project! We appreciate your support 🚀 Don't forget to leave a star ⭐ Happy Coding!!❤️