|
1 | 1 | # Content planner |
2 | 2 |
|
3 | | -# Roadmap |
| 3 | +Content Planner is a powerful and efficient tool for planning and managing your content creation process, written primarily in TypeScript with some components in Rust. |
| 4 | + |
| 5 | +## Quick Demo |
| 6 | + |
| 7 | +To see Content Planner in action, follow these steps: |
| 8 | + |
| 9 | +1. Clone the repository: |
| 10 | + |
| 11 | + ```sh |
| 12 | + git clone https://github.com/bartosz-skejcik/content-planner.git |
| 13 | + cd content-planner |
| 14 | + ``` |
| 15 | + |
| 16 | +2. Install dependencies: |
| 17 | + |
| 18 | + ```sh |
| 19 | + npm install |
| 20 | + ``` |
| 21 | + |
| 22 | +3. Build the project: |
| 23 | + |
| 24 | + ```sh |
| 25 | + npm run build |
| 26 | + ``` |
| 27 | + |
| 28 | +4. Start the server: |
| 29 | + ```sh |
| 30 | + npm start |
| 31 | + ``` |
| 32 | + |
| 33 | +Visit `http://localhost:3000` in your browser to access the application. |
| 34 | + |
| 35 | +## Features |
| 36 | + |
| 37 | +### Idea Bank |
| 38 | + |
| 39 | +- **Basic Functionality:** Store and manage your content ideas. |
| 40 | +- **Schema, Search, Tagging:** Organize your ideas with schemas, search functionality, and tags. |
| 41 | +- **Integration with Video Entries:** Integrate your content ideas directly with video entries. |
| 42 | + |
| 43 | +### Task Tracker |
| 44 | + |
| 45 | +- **Subtasks:** Break down tasks into smaller, manageable subtasks. |
| 46 | +- **Drag-and-Drop Calendar:** Easily manage deadlines and tasks with a drag-and-drop calendar. |
| 47 | + |
| 48 | +### AI-Powered Suggestions |
| 49 | + |
| 50 | +- **Script and Thumbnail Suggestions:** Utilize AI to generate script ideas and thumbnail suggestions. |
| 51 | + |
| 52 | +### Notifications and Labels |
| 53 | + |
| 54 | +- **Deadline Notifications:** Receive notifications for upcoming deadlines, integrated with calendar and tasks. |
| 55 | +- **Status Labels:** Track video progress with customizable status labels. |
| 56 | + |
| 57 | +### Analytics and Reporting |
| 58 | + |
| 59 | +- **Progress Charts:** Visualize workflow efficiency with progress charts and analytics. |
| 60 | + |
| 61 | +### Scriptwriting and Storyboarding |
| 62 | + |
| 63 | +- **Script Editor:** Use a distraction-free script editor with templates and version control. |
| 64 | +- **Readability Analyzer:** Analyze scripts for readability and runtime estimates. |
| 65 | +- **Storyboarding Tools:** Visualize scenes and shots with storyboarding tools. |
| 66 | + |
| 67 | +### Collaboration |
| 68 | + |
| 69 | +- **Multi-User Support:** Collaborate with team members in real-time. |
| 70 | +- **Cloud Storage:** Store video data, scripts, and assets in the cloud. |
| 71 | + |
| 72 | +### From Releases |
| 73 | + |
| 74 | +You can download and install Content Planner from the [releases page](https://github.com/bartosz-skejcik/content-planner/releases). The following files are available for each release: |
| 75 | + |
| 76 | +- `content-planner.x86_64.rpm`: RPM package for Linux (x86_64) |
| 77 | +- `content-planner_aarch64.dmg`: DMG package for macOS (Apple Silicon) |
| 78 | +- `content-planner_amd64.AppImage`: AppImage for Linux (AMD64) |
| 79 | +- `content-planner_amd64.deb`: DEB package for Linux (AMD64) |
| 80 | +- `content-planner_x64-setup.exe`: Setup executable for Windows (x64) |
| 81 | +- `content-planner_x64.dmg`: DMG package for macOS (Intel) |
| 82 | +- `content-planner_x64_en-US.msi`: MSI installer for Windows (x64) |
| 83 | +- `content-planner_aarch64.app.tar.gz`: Tarball for Linux (Apple Silicon) |
| 84 | +- `content-planner_x64.app.tar.gz`: Tarball for Linux (x64) |
| 85 | +- `Source code (zip)` |
| 86 | +- `Source code (tar.gz)` |
| 87 | + |
| 88 | +Download the appropriate file for your operating system and follow the installation instructions. |
| 89 | + |
| 90 | +### Running Locally |
| 91 | + |
| 92 | +To run Content Planner locally, follow these steps: |
| 93 | + |
| 94 | +1. Clone the repository: |
| 95 | + |
| 96 | + ```sh |
| 97 | + git clone https://github.com/bartosz-skejcik/content-planner.git |
| 98 | + cd content-planner |
| 99 | + ``` |
| 100 | + |
| 101 | +2. Install dependencies: |
| 102 | + |
| 103 | + ```sh |
| 104 | + bun install |
| 105 | + ``` |
| 106 | + |
| 107 | +3. Start the development server: |
| 108 | + ```sh |
| 109 | + bun dev:tauri |
| 110 | + ``` |
| 111 | + |
| 112 | +This application is built using Tauri and Bun, ensuring a lightweight and fast experience. |
| 113 | + |
| 114 | +## Roadmap |
4 | 115 |
|
5 | 116 | | **Stage** | **Goals** | **Timeline** | **Status** | |
6 | 117 | | ----------- | --------------------------------------------------------------------------------------------------- | -------------- | ------------- | |
7 | 118 | | **Stage 1** | **Foundational Improvements:** | **2-3 weeks** | `in-progress` | |
8 | 119 | | | - [x] Refactor store for performance. | | `done` | |
9 | 120 | | | - [x] Implement **Idea Bank** (basic functionality): | | `done` | |
| 121 | +| | - [x] Implement video type, status, priority & target audience settings. | | `done` | |
| 122 | +| | - [ ] Implement idea to video plan conversion. | | `in-progress` | |
10 | 123 | | | - [ ] Schema, search, tagging, and integration with video entries. | | `in-progress` | |
11 | 124 | | | - [ ] Add subtasks to Task Tracker. | | `in-progress` | |
12 | | -| | - [ ] Drag-and-drop in the calendar (for deadlines and tasks). | | `backlog` | |
13 | 125 | | **Stage 2** | **Core Feature Enhancements:** | **4-5 weeks** | `backlog` | |
14 | 126 | | | - [ ] AI-powered script and thumbnail suggestions. | | `backlog` | |
15 | 127 | | | - [ ] Deadline notifications (integrated with calendar and tasks). | | `backlog` | |
|
24 | 136 | | | - [ ] Cloud storage for video data, scripts, and assets. | | `backlog` | |
25 | 137 | | | - [ ] Real-time collaboration on tasks and scripts. | | `backlog` | |
26 | 138 | | **Ongoing** | - [ ] UX and UI polish based on feedback.<br>- [ ] Ensure scalability and performance optimization. | **Continuous** | `backlog` | |
| 139 | + |
| 140 | +## Contributing |
| 141 | + |
| 142 | +We welcome contributions of all kinds! If you have an idea for a new feature or have found a bug, please open an issue or submit a pull request. |
| 143 | + |
| 144 | +1. Fork the repository |
| 145 | +2. Create a new branch (`git checkout -b feat/feature-name`) |
| 146 | +3. Make your changes |
| 147 | +4. Commit your changes (`git commit -m 'add: new feature'`) |
| 148 | +5. Push to the branch (`git push origin feat/feature-name`) |
| 149 | +6. Open a pull request |
| 150 | + |
| 151 | +Please make sure to update tests as appropriate. |
| 152 | + |
| 153 | +## License |
| 154 | + |
| 155 | +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. |
0 commit comments