Skip to content

Latest commit

 

History

History
100 lines (59 loc) · 3.75 KB

README.md

File metadata and controls

100 lines (59 loc) · 3.75 KB

DIGITAL PRIVACY EDUCATION (DPE)

Digital Privacy Education is an open-source project focused on providing enlightenment and information on the best practices for staying secure online. The project is built using Next.js and Tailwind CSS, with a primary goal of promoting digital privacy. The project consists of multiple phases, with the second phase introducing a community forum where users and experts can discuss and share insights about online security.

dpe-heroimg

figma:https://www.figma.com/file/xT3vTl7J1rUOGdEn0sUAFy?node-id=0:1&locale=en&type=design

project overview:https://docs.google.com/document/d/1zYIrInrfQ5LCGrnmZCrZSRRKEHe_wsRtr4pWw1NEvKM/edit?usp=drivesdk

PRD:https://docs.google.com/document/d/156XhEXCu03gZNh-2gd9xb8swrXkqni0N/edit?usp=drivesdk&ouid=115221145025454397775&rtpof=true&sd=true

Tool Demo: https://www.loom.com/share/ad90c0d68daf4f26817e65297782ffcb?sid=c262240a-6d7f-4466-8727-98dbce5ce501

live link: https://digitalprivacyedu.netlify.app

Table of Contents:

  • Introduction
  • Installation
  • Running the Project
  • Features
  • Project Phases
  • Contributing
  • License
  • Introduction

This repository contains the Digital Privacy Education project, which aims to help users understand how to protect their privacy in the digital world. Built with Next.js and Tailwind CSS, the project emphasizes user experience, simplicity, and modern design.

The repository uses pnpm as its package manager. All contributors must follow the guidelines outlined in this documentation, and any additional tools or features should be approved by the repository owners/handlers before implementation.

Installation:

To get started with this project, you need to have pnpm installed on your local machine. If pnpm is not installed, you can follow the official pnpm installation guide.

Once pnpm is installed, follow these steps:

  1. Clone the repository:
  1. Navigate to the project directory:
  • cd digital-privacy-education
  1. Install the dependencies:
  • pnpm install

Running the Project: To run the project locally for development, use the following command:

  • pnpm dev

****This will start a local development server on http://localhost:3000, where you can view and work on the project.

Features:

~ Next.js framework for server-side rendering and static site generation ~ Tailwind CSS for responsive and modern styling ~ Community-driven forum (Phase 2) where users can ask questions and share knowledge ~ Focus on digital privacy education and best practices.

Project Phases:

Phase 1: Development of static and educational pages to provide users with information about online security and privacy.

Phase 2: Introduction of the community forum, allowing users to engage in discussions and share privacy-related knowledge.

Phase 3: Advanced features to be determined based on community feedback and evolving needs.

Contributing

We welcome contributions to improve the project. If you want to contribute and create impact!

  • Fork the repository.
  1. Create a new branch with a descriptive name:
  • git checkout -b feature-name
  1. Make your changes and commit them:
  • git commit -m "Add feature-name"
  1. Push your branch:
  • git push origin feature-name
  1. Open a Pull Request for review. Note: Any new tools or dependencies should be approved by the repository handlers before they are added.

Contributors

https://github.com/anafisad/anafisad https://github.com/Fahtymah/Fahtymah https://github.com/sommie11

License This project is licensed under the MIT License.

This documentation provides an overview of the setup and contribution process. For additional questions, feel free to open an issue on the repository or contact the maintainers directly.