https://github.com/probablyarth/clip-master
https://github.com/probablyarth/clip-master
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/probablyarth/clip-master
- Owner: probablyArth
- License: mit
- Created: 2024-07-13T19:49:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-15T10:27:18.000Z (almost 2 years ago)
- Last Synced: 2025-02-25T03:23:58.494Z (over 1 year ago)
- Language: TypeScript
- Size: 249 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# clip-master
## Overview
`clip-master` is an application that offers REST APIs for managing video files, including features for uploading, trimming, merging, and sharing videos.
## Getting Started
These instructions will help you set up the project on your local machine for development and testing purposes.
### Prerequisites
- Node.js (v18 or higher)
- Yarn (v1.22 or higher)
## Features
- User Authentication
- Admin Management
- Video Upload
- Video Trimming
- Video Merging
- Video Download
## Technologies Used
- Node.js
- Express.js
- TypeScript
- SQLite (via Prisma ORM)
- fluent-ffmpeg for video processing
- Swagger for API Documentation
### Installation
1. Clone the repository:
```bash
git clone https://github.com/probablyarth/clip-master.git
cd clip-master
```
2. Install the dependencies:
```bash
yarn
```
3. Set up the database:
```bash
npx prisma migrate dev
```
4. Copy environment variables to .env:
```bash
cp .env.example .env
```
### Running the Application
1. Start the development server:
```bash
yarn dev
```
2. The server will be running on `http://localhost:8000`.
### Linting:
To run the linter:
```bash
yarn lint
```
### Running tests:
1. To run the test suite:
```bash
yarn test
```
### Building for Production
1. Build the application:
```bash
yarn build
```
2. Start the production server:
```bash
yarn start
```
### API Documentation
The API documentation is available via Swagger UI. You can access it at: https://app.swaggerhub.com/apis/BINODLABS/clip_master/1.0.0
## LICENSE
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.