An AI-powered productivity platform for multi-platform file synchronization, document management, and workflow automation. This project includes accessible features designed with the deaf community in mind.
This started as an early learning project built on Replit. It has since evolved into a more structured codebase suitable for community contributions. While some rough edges remain from the learning stage, the project demonstrates:
- Multi-platform file synchronization (Ubuntu, Windows, iOS, Dropbox, Google Drive)
- AI-powered document categorization and analysis
- Workflow automation for document processing
- Accessibility-focused features for visual-centric workflows
- Node.js 20+
- PostgreSQL 16+
- Python 3.11+ (for AI analysis scripts)
-
Clone the repository:
git clone https://github.com/pinkycollie/pinksync_estimator.git cd pinksync_estimator -
Install dependencies:
npm install
-
Set up environment variables (see
.env.examplefor required variables) -
Start the development server:
npm run dev
See PROJECT_STRUCTURE.md for detailed architecture documentation.
client/- React frontend applicationserver/- Express.js backend APIshared/- Shared TypeScript types and schemas
This project requires several environment variables for full functionality. See .env.example for a template. Never commit actual API keys or secrets to the repository.
| Variable | Description | Required |
|---|---|---|
DATABASE_URL |
PostgreSQL connection string | Yes |
HUGGINGFACE_API_KEY |
HuggingFace API key for embeddings | Optional |
OPENAI_API_KEY |
OpenAI API key for AI features | Optional |
Contributions are welcome! Please read the contributing guidelines before submitting pull requests.
Please see SECURITY.md for security policies and how to report vulnerabilities.
This project is licensed under the MIT License - see the package.json file for details.