Pixel Pouch

Explore the docs »

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Optimizations
6. Contributing
7. Contact

About

Admin Portal

Client Portal

Pixel Pouch is a desktop and mobile friendly app utilizing Next.js and Supabase that is a web-developer to client file sharing and communication platform that is not just functional, but also intuitive and user-friendly, catering to clients who found existing services like Dropbox overly complex.

Built With

(back to top)

Getting Started

Instructions to setup Pixel Pouch on your local machine below.

Prerequisites

npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/LukeLarson2/project-pixel-pouch.git

2. Install NPM packages

   npm install

3. Enter your port, API URL, and Github Token in .env.local file

    NEXT_PUBLIC_SUPABASE_URL = (your supabase database URL)
    NEXT_PUBLIC_SUPABASE_ANON_KEY = (your supabase token)

4. Run in dev environment.

   npm run dev

Usage

Pixel Pouch is run on the designated port. It can also be accessed utilizing localhost:PORT directly in the browser.

Run linter: npm run lint

(back to top)

Roadmap

• Include a client landing page with folder/file navigation
• Develop a file preview page with enlarge image previews
• Implement client new message notification system
• Integrate upload file to a specified directory
• Inovate a cleat client managment gui for admin to navigate/create clients, folders and files
• Leverage Stripe API for subscriptions

(back to top)

Optimizations

1. Reduction in query times leveraging the RDMBS structure of supabase reducing latency to 53ms on login screen with 0% error rate and 100 RPS throughput
2. Modernized the user experience with responsive layouts allowing for mobile and desktop usage
3. Refined the ease of use for clients with eliminating need of file navigation to upload to a particular file

Contributing

Feel free to join in! Whether its fixing bugs, improving documentation, or simply spreading the word!

Contact

Luke

Linkedin | GitHub

(back to top)