- Introduction
- Project Description
- Features
- How it Works
- Inspiration
- Usage
- Installation
- Import Request Collection
- Environment Variables
- Support
- Contributing
- License
Welcome to CodeVault, a revolutionary platform for student freelancers to securely sell their source code to their peers. The app allows users to upload their projects in a zip format, which is then protected by a unique password. This ensures that the source code remains exclusive to the purchaser, preventing unauthorized sharing and maintaining the value of your hard work. Whether you're a student freelancer or someone in need of a quality project, CodeVault is your one-stop solution!
CodeVault is designed to address the challenges faced by student freelancers like us. We often create unique and valuable projects for our fellow students, but protecting the source code and ensuring fair compensation can be challenging. With CodeVault, we have created a simplified version of Patreon, focused on secure distribution and accessibility for both sellers and buyers.
- Secure File Protection: CodeVault employs state-of-the-art encryption to protect the source code files within the zip, ensuring only the buyer can access them with the unique password.
- Effortless Uploads: As a seller, you can easily upload your project as a zip file, and the platform takes care of the rest, adding the necessary password protection.
- Password Generation: The platform generates strong passwords for each uploaded project, ensuring enhanced security.
- Seamless Transactions: CodeVault handles the transactions between the sellers and buyers securely, making it easy for everyone to participate.
- User-Friendly Interface: The app offers an intuitive and easy-to-navigate interface, allowing users to browse, search, and purchase projects effortlessly.
- Support for Multiple Formats: CodeVault supports various programming languages and project types, making it a versatile marketplace for students.
- Seller Uploads Project: As a seller, you can upload your project in zip format through your CodeVault account.
- Password Generation: CodeVault automatically generates a unique password for the zip file, ensuring security.
- Listing on CodeVault: Your project is listed on CodeVault, accessible to potential buyers.
- Buyer Purchases Project: Buyers can explore the available projects, make a purchase, and download the zip file with the secure password.
- Secure Access: The buyer can access and use the source code, while the encryption ensures it remains protected.
Imagine a world where student freelancers can easily share their hard work without worrying about unauthorized distribution. As student freelancers ourselves, we understand the struggle of creating projects and wanting to sell them while protecting our intellectual property. The inspiration behind CodeVault stems from our desire to create a simpler version of Patreon, exclusively tailored to address the needs of student developers.
Our passion for coding and the pursuit of a fair and secure marketplace for student freelancers led us to conceptualize CodeVault. We want to empower fellow students to showcase their talent, earn a fair income, and contribute to the academic community. By ensuring their work remains protected, we aim to foster a culture of respect for intellectual property among students.
With CodeVault, we envision a future where student freelancers can focus on honing their skills and creating innovative projects, knowing that their hard work is valued and protected.
Usage To start using CodeVault, please follow these steps:
- Sign up for an account.
- As a seller, upload your projects in zip format.
- As a buyer, explore the available projects and purchase the ones you find interesting.
- After purchase, you'll receive the zip file with the encrypted password to access the source code.
To set up the project locally for development, follow these steps:
- Clone the GitHub repository:
git clone https://github.com/jae-sd/hackathon - Navigate to the project folder.
- Install the required Node.js dependencies:
npm install - Start the development server:
npm run dev
You are now ready to work on the CodeVault project locally. Happy coding!
To get started with the hackathon, follow these steps to import the request collection into Insomnia:
- Make sure you have Insomnia installed on your machine.
- Locate the request collection file in the Insomnia directory. It should be located in the root folder of your project.
- Copy the request collection file (usually with a
.jsonextension) from the Insomnia directory. - Open Insomnia on your machine.
- In Insomnia, go to
File>Import Data>From File.... - Choose the copied request collection file from the Insomnia directory.
- Insomnia will import the request collection and display it in the workspace.
- You can now explore the imported request collection, make requests, and test your hackathon project using Insomnia.
Please note that the above instructions assume you have the request collection file ready in the Insomnia directory. Make sure to follow any additional project-specific instructions provided by your hackathon organizers.
If you encounter any issues or need further assistance, feel free to reach out for support. Good luck with your hackathon!
Make sure to set up the following environment variables for CodeVault to work correctly:
- MONGODB_COMPASS_URL=
<your_mongodb_compass_url>
- MONGODB_ATLAS_URL=
<your_mongodb_atlas_url>
- TREBLLE_API_KEY=
<your_treblle_api_key> - TREBLLE_PROJECT_ID=
<your_treblle_project_id>
- ACCESS_TOKEN_SECRET=
<your_access_token_secret> - REFRESH_TOKEN_SECRET=
<your_access_token_secret>
- CONVERT_API_KEY=
<your_convert_api_key> - CONVERT_API_SECRET=
<your_convert_api_secret>
- PAYSTACK_SECRET_KEY=
<your_paystack_secret_key> - PAYSTACK_PUBLIC_KEY=
<your_paystack_public_key>
Please ensure that you obtain the necessary credentials and replace the placeholders with your actual values for these environment variables.
If you encounter any issues or have questions, please reach out to our support team at [email protected]. We are available 24/7 to assist you.
We believe in the power of collaboration and welcome contributions from the community. If you have any ideas or want to contribute to the development of CodeVault, please check out our Contribution Guidelines.
CodeVault is licensed under the MIT License. Feel free to use, modify, and distribute it according to the terms of the license.
Thank you for considering CodeVault for the hackathon! We are excited about the potential impact this project can have on student freelancers and the academic community. With our focus on secure file protection and user-friendly features, we believe CodeVault stands out as a valuable solution for creators and buyers alike. We look forward to showcasing our project and demonstrating how CodeVault can transform the way students buy and sell their source code securely.
Best regards, Infinite Loop Team