Welcome to the frontend repository of Vouz, an open-source, no-login, fully encrypted file-sharing platform. This project allows users to create secure lockers for file storage and sharing without the need for user accounts. For backend implementation details, visit the Vouz Backend Repository.
- No Login Required: Share files effortlessly without creating an account.
- Secure Lockers: Protect your files with unique passkeys.
- Easy Sharing: Share locker names and passkeys to grant access.
- Open Source: Contribute to the project and help improve it.
Explore the live application at vouz.tech. Take a look at the features on YouTube
To set up the project locally, follow these steps:
-
Clone the Repository:
git clone https://github.com/zadescoxp/locker-frontend.git cd locker-frontend -
Install Dependencies:
npm install
-
Configure Environment Variables:
Create a
.env.localfile in the root directory with the following variables:LOCK_SECRET=your_lock_secret NEXT_PUBLIC_BACKEND_URL=http://localhost:5000
LOCK_SECRET: Replaceyour_lock_secretwith a secure secret key for encryption.NEXT_PUBLIC_BACKEND_URL: Set this to the URL where your backend server is running.
Note: Variables prefixed with
NEXT_PUBLIC_are exposed to the browser. Ensure that no sensitive information is included in these variables. -
Run the Development Server:
npm run dev
Open http://localhost:3000 in your browser to view the application.
We welcome contributions! To get started:
- Fork the repository.
- Create a new branch:
git checkout -b feature-branch-name. - Make your changes.
- Commit your changes:
git commit -m 'Add new feature'. - Push to the branch:
git push origin feature-branch-name. - Open a pull request.
Please ensure your code adheres to our coding standards and includes appropriate tests.
This project is licensed under the MIT License. See the LICENSE file for details.
For questions or suggestions, please open an issue in this repository.
Thank you for contributing to Vouz!