Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ProSe Configuration Example
# Copy this file to .env and fill in your actual values

# Jules API Key
# Obtain from: https://jules.ai (or your Jules provider)
JULES_API_KEY=your_jules_api_key_here

# Prose2 Configuration (optional)
# PROSE2_API_KEY=your_prose2_api_key_here
# PROSE2_ENDPOINT=https://api.prose2.example.com

# File Organizer Configuration (optional)
# FILE_ORGANIZER_PATH=/path/to/organize
# FILE_ORGANIZER_RULES_PATH=./config/organizer-rules.json

# General Settings
NODE_ENV=development
LOG_LEVEL=info
36 changes: 36 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Dependencies
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Environment variables
.env
.env.local
.env.*.local

# Build outputs
dist/
build/
*.log

# IDE
.vscode/
.idea/
*.swp
*.swo
*~

# OS
.DS_Store
Thumbs.db

# Temporary files
tmp/
temp/
*.tmp

# API Keys and Secrets
secrets/
*.key
*.pem
80 changes: 80 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Contributing to ProSe

Thank you for your interest in contributing to ProSe! This document provides guidelines for contributing to the project.

## Getting Started

1. Fork the repository
2. Clone your fork: `git clone https://github.com/YOUR-USERNAME/ProSe.git`
3. Create a new branch: `git checkout -b feature/your-feature-name`
4. Make your changes
5. Test your changes
6. Commit your changes: `git commit -am 'Add some feature'`
7. Push to the branch: `git push origin feature/your-feature-name`
8. Submit a pull request

## Development Setup

1. Install dependencies:
```bash
npm install
```

2. Copy `.env.example` to `.env` and configure your API keys:
```bash
cp .env.example .env
```

3. Run the development version:
```bash
npm run dev
```

## Code Style

- Use ES6+ features
- Follow existing code formatting
- Add comments for complex logic
- Keep functions small and focused

## Testing

Before submitting a pull request:

1. Ensure all existing tests pass: `npm test`
2. Add tests for new features
3. Verify code works with different configurations

## Integration Guidelines

### Adding New Integrations

When adding a new integration module:

1. Create a new directory in `src/` with the integration name
2. Create an `index.js` file with the integration class
3. Export the class following the pattern of existing integrations
4. Update `src/index.js` to include the new integration
5. Add configuration options to `config/default.json`
6. Document the integration in README.md

### API Key Management

- Never commit API keys or secrets
- Always use environment variables
- Add new keys to `.env.example` with placeholder values
- Document required API keys in README.md

## Pull Request Process

1. Update README.md with details of changes if applicable
2. Update the version number following [Semantic Versioning](https://semver.org/)
3. Your PR will be reviewed by maintainers
4. Address any feedback or requested changes
5. Once approved, your PR will be merged

## Questions?

If you have questions, please open an issue or reach out to the maintainers.

Thank you for contributing! 🎉
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 ProSe Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
101 changes: 100 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,101 @@
# ProSe
the main module for Prose' litagints

The main module for Prose integration with AI assistants and file organizers.

## Overview

ProSe is a modular repository designed to integrate:
- **Prose2**: Advanced AI-powered writing and editing capabilities
- **Prose File Organizer**: Intelligent file organization and management
- **Jules**: AI workspace integration

> 📖 **New to ProSe?** Check out the [Setup Summary](docs/SETUP_SUMMARY.md) for a comprehensive overview of what was created and how to use it.

## Features

- Modular architecture for easy integration
- API key management for secure service integration
- Extensible plugin system
- Configuration-driven setup

## Getting Started

### Prerequisites

- Node.js 18 or higher
- npm or yarn package manager

### Installation

```bash
npm install
```

### Configuration

Create a `.env` file in the root directory with your API keys:

```env
# Jules API Key (if required)
JULES_API_KEY=your_api_key_here

# Other API keys as needed
# PROSE2_API_KEY=your_api_key_here
```

See `.env.example` for all available configuration options.

## Project Structure

```
ProSe/
├── src/
│ ├── prose2/ # Prose2 integration module
│ ├── file-organizer/ # File organizer integration
│ └── jules/ # Jules workspace integration
├── config/ # Configuration files
├── docs/ # Documentation
└── examples/ # Example configurations
```

## Usage

### Jules Integration

The Jules integration provides AI-powered workspace assistance. Configure it in your workspace settings.

### Prose2 Integration

Integrate advanced writing capabilities into your workflow.

### File Organizer

Automatically organize and manage your files based on intelligent rules.

## Development

### Running Tests

```bash
npm test
```

### Building

```bash
npm run build
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to this project.

## Documentation

- [API Documentation](docs/API.md) - Complete API reference for all modules
- [Jules Integration Guide](docs/JULES.md) - Detailed guide for Jules workspace integration
- [Setup Summary](docs/SETUP_SUMMARY.md) - Comprehensive overview of the repository setup

## License

MIT License - see LICENSE file for details.
40 changes: 40 additions & 0 deletions config/default.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
{
"jules": {
"enabled": true,
"workspace": "default",
"features": {
"codeAssist": true,
"contextAware": true,
"autoComplete": true
}
},
"prose2": {
"enabled": true,
"features": {
"grammarCheck": true,
"styleAnalysis": true,
"suggestions": true
}
},
"fileOrganizer": {
"enabled": true,
"watchDirectories": [],
"rules": [
{
"name": "Documents",
"pattern": "\\.(doc|docx|pdf|txt)$",
"destination": "Documents"
},
{
"name": "Images",
"pattern": "\\.(jpg|jpeg|png|gif|svg)$",
"destination": "Images"
},
{
"name": "Code",
"pattern": "\\.(js|ts|py|java|cpp|cs)$",
"destination": "Code"
}
]
}
}
Loading