https://github.com/ahad324/docnow
π Welcome to the Documents Sharing App! π Easily upload, download, and manage files. Real-time updates, admin controls, and a sleek drag-and-drop interface make file sharing a breeze! Built with βοΈ React, β‘ Vite, π¦ Appwrite, π¨ Tailwind CSS, and π Framer Motion.
https://github.com/ahad324/docnow
docs document-sharing file-sharing file-upload sharing sharing-platform
Last synced: 3 months ago
JSON representation
π Welcome to the Documents Sharing App! π Easily upload, download, and manage files. Real-time updates, admin controls, and a sleek drag-and-drop interface make file sharing a breeze! Built with βοΈ React, β‘ Vite, π¦ Appwrite, π¨ Tailwind CSS, and π Framer Motion.
- Host: GitHub
- URL: https://github.com/ahad324/docnow
- Owner: ahad324
- Created: 2024-08-01T17:05:10.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T18:10:41.000Z (6 months ago)
- Last Synced: 2024-11-07T19:24:04.812Z (6 months ago)
- Topics: docs, document-sharing, file-sharing, file-upload, sharing, sharing-platform
- Language: JavaScript
- Homepage: https://docnow.netlify.app/
- Size: 2.75 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
π Doc Now π€
Welcome to Doc Now! π This application allows users to upload and download files publicly, featuring a clean and modern design, responsive components, and a secure admin interface. Below, you'll find details on how to get started, the technologies used, and more.
## π Table of Contents
- [Features](#-features)
- [UseCases](#-use-cases)
- [Demo](#-demo)
- [Technologies Used](#-technologies-used)
- [Installation](#-installation)
- [Usage](#-usage)
- [Contributing](#-contributing)
- [Feedback](#-feedback)
## β¨ Features
- π **File Upload and Download**: Upload and download files without needing an account.
- π **Admin Authentication**: Admin can log in to manage and delete files.
- β‘ **Real-time Updates**: Get real-time updates when files are uploaded or deleted.
- πΌοΈ **Responsive Design**: Fully responsive and mobile-friendly.
- π **SEO Optimized**: Enhanced with SEO best practices for better search engine ranking.
- π¨ **Smooth Animations**: Utilizes Framer Motion for fluid drag-and-drop animations.
## π **Use Cases**
### **Scenario 1: The Classroom Conundrum**
Your lab teacher has just assigned a challenging task, and suddenly, everyone is stumpedβexcept for one person! π± This creates a dilemma for the entire class. But donβt worry, thereβs a simple solution! The student who understands the task can easily upload their file here, allowing everyone in the class to access it in just seconds. β±οΈβ¨
> **Note**: Since code files are typically just a few kilobytes in size, you wonβt have to worry about long upload or download times. π And it gets even betterβyou can upload any type of file, making this platform versatile for all your needs! ππ»
### **Scenario 2: The Exam Dilemma**
Youβre in an exam, and only one person knows how to solve a particular problem. π€ This platform can be a lifesaver in that situation too! π
---
πΏππβπ ππΆππ πΈππππΆπ·πππΆππΎππ ππΆππΎππ πΆππΉ ππππ ππ»π»πΎπΈπΎπππ π»ππ ππππππππ! π€π‘
## π₯ Demo
Check out the live demo of the application [here](https://docnow.netlify.app/).
## π οΈ Technologies Used
- **React/Vite**: JavaScript library for building user interfaces.
- **Appwrite**: Open-source backend server for web, mobile, and flutter developers.
- **Framer Motion**: Powerful animation library for React.
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development.
## ποΈ Installation
To get a local copy up and running, follow these steps:
1. **Clone the repository:**
```bash
git clone https://github.com/ahad324/DocNow.git
```
2. **Navigate to the project directory:**
```bash
cd DocNow
```
3. **Install dependencies:**
```bash
npm install
```
4. **Create an .env file and add your Appwrite credentials:**
```bash
VITE_PROJECT_ID=your_project_id
VITE_ENDPOINT=your_appwrite_endpoint
VITE_BUCKET_ID=your_bucket_id
```
5. **Start the development server:**
```bash
npm run dev
```
## π Usage
Once the server is running, you can:
- Upload and download files directly from the main interface.
- Access the admin panel by navigating to `/admin` and logging in with the admin credentials.
- Enjoy the smooth animations and responsive design on any device.
## π€ Contributing
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## π¬ Feedback
Iβd love to hear from you! If you have any feedback or suggestions, please open an issue or submit a pull request. Your stars β and contributions help me keep improving and maintaining this project! π