ujjwalnp/freelanceshield

Fortifying Freelancers, Safeguarding Clients

FreelanceShield

FreelanceShield ensures safe and easy collaboration between freelancers and clients worldwide. With smart contracts and secure payments, it's your go-to platform for trustworthy freelance partnerships. Experience a secure freelance journey with FreelanceShield!

It is a platform governed by an escrow-based smart contract that is designed to streamline the Freelance Payments. The platform have the smart contract to take care of the security deposit and prevent the transacting parties from defaulting.

Installation Instructions

To run the code, you can either copy the contract and use Remix IDE. Or you can clone the repository using

git clone https://github.com/ujjwalnp/FreelanceShield.git

Go into the directory

cd FreelanceShield

Install the dependencies running Install the dependencies running

1. Copy the .env.example file to .env.
2. Obtain an Infura API key and set it as the value for INFURA_API_KEY in the .env file.
3. Replace your_mnemonic_here with your actual mnemonic phrase in the .env file.
4. Run the following commands in your terminal:

npm install 
npm install -g truffle

Install the rest of the dependencies if necessary. Compile the files with

truffle compile
truffle migrate --network sepolia

Run the project using

npm start

Contributions

Contributions are welcome! If you'd like to contribute to this repository, please follow the guidelines in the CONTRIBUTING.md file.

Thank You!

freelanceshield's Issues

Add Frontend Components and Functionalities

Feature Request: Frontend Components and Functionalities

Deadline: January 7, 2024

Components:

1. Landing Page
2. Sign-in/Sign-Up Page
3. Dashboard (Client & Freelancer View)
4. Project State Updation Page (Client & Freelancer View)

Client Functionalities:

• Create Contracts
• Deposit Security Deposit
• Update Project State
• Review Project State
• Transfer Funds

Freelancer Functionalities:

• Sign Contract
• Deposit Security Deposit
• Update Project State
• Mark Project as Completed
• Verify Transactions

Enhance Getting Started and Installation Instructions

Issue: Enhance Getting Started and Installation Instructions

Description

There are specific modifications that need to be implemented to improve the clarity and user experience in the documentation.

Proposed Changes

1. Deployment URL in "Getting Started" Section

Incorporate the deployment URL in the "Getting Started" section as follows:

## Getting Started
Explore the codebase and experience SecureFreelance live on [Vercel](https://freelanceshield.vercel.app/).

2. Revised Installation Instructions

Revise the installation instructions for better clarity

## Installation
To initiate SecureFreelance locally, follow these straightforward installation steps:

3. Adjust Installation Commands

Adjust the installation commands, such as git clone and cd, accordingly.

Note: These proposed changes may not be identical, but they align with the intended modifications. Feel free to refine them as needed.