mirror of
https://github.com/mediacms-io/mediacms.git
synced 2025-11-06 15:38:53 -05:00
Update README.md
This commit is contained in:
parent
01df72a115
commit
f74874d656
@ -4,28 +4,28 @@ A modern browser-based video editing tool built with React and TypeScript that i
|
|||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- ⏱️ Trim video start and end points
|
- ⏱️ Trim video start and end points
|
||||||
- ✂️ Split videos into multiple segments
|
- ✂️ Split videos into multiple segments
|
||||||
- 👁️ Preview individual segments or the full edited video
|
- 👁️ Preview individual segments or the full edited video
|
||||||
- 🔄 Undo/redo support for all editing operations
|
- 🔄 Undo/redo support for all editing operations
|
||||||
- 🔊 Audio mute controls
|
- 🔊 Audio mute controls
|
||||||
- 💾 Save edits directly to MediaCMS
|
- 💾 Save edits directly to MediaCMS
|
||||||
|
|
||||||
## Tech Stack
|
## Tech Stack
|
||||||
|
|
||||||
- React 18
|
- React 18
|
||||||
- TypeScript
|
- TypeScript
|
||||||
- Vite
|
- Vite
|
||||||
- Tailwind CSS
|
- Tailwind CSS
|
||||||
- Express (for development server)
|
- Express (for development server)
|
||||||
- Drizzle ORM
|
- Drizzle ORM
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- Node.js (v20+) - Use `nvm use 20` if you have nvm installed
|
- Node.js (v20+) - Use `nvm use 20` if you have nvm installed
|
||||||
- Yarn or npm package manager
|
- Yarn or npm package manager
|
||||||
|
|
||||||
### Setup
|
### Setup
|
||||||
|
|
||||||
@ -119,13 +119,52 @@ npm run deploy
|
|||||||
|
|
||||||
## Project Structure
|
## Project Structure
|
||||||
|
|
||||||
- `/src` - Source code
|
- `/src` - Source code
|
||||||
- `/components` - React components
|
- `/components` - React components
|
||||||
- `/hooks` - Custom React hooks
|
- `/hooks` - Custom React hooks
|
||||||
- `/lib` - Utility functions and helpers
|
- `/lib` - Utility functions and helpers
|
||||||
- `/services` - API services
|
- `/services` - API services
|
||||||
- `/styles` - CSS and style definitions
|
- `/styles` - CSS and style definitions
|
||||||
|
|
||||||
## API Integration
|
## API Integration
|
||||||
|
|
||||||
The video editor interfaces with MediaCMS through a set of API endpoints for retrieving and saving video edits.
|
The video editor interfaces with MediaCMS through a set of API endpoints for retrieving and saving video edits.
|
||||||
|
|
||||||
|
Sure! Here's your updated `README.md` section with a new **"Code Formatting"** section using Prettier. I placed it after the "Development" section to keep the flow logical:
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Code Formatting
|
||||||
|
|
||||||
|
To automatically format all source files using [Prettier](https://prettier.io):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Format all code in the src directory
|
||||||
|
npx prettier --write src/
|
||||||
|
```
|
||||||
|
|
||||||
|
Or for specific file types:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx prettier --write "client/src/**/*.{js,jsx,ts,tsx,json,css,scss,md}"
|
||||||
|
```
|
||||||
|
|
||||||
|
You can also add this as a script in `package.json`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
"scripts": {
|
||||||
|
"format": "prettier --write client/src/"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Then run:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn format
|
||||||
|
# or
|
||||||
|
npm run format
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
Let me know if you'd like to auto-format on commit using `lint-staged` + `husky`.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user