https://github.com/codevideo/codevideo-adapters
Adapters for third party services (file system, github, etc.) to connect to the CodeVideo ecosystem.
https://github.com/codevideo/codevideo-adapters
Last synced: 4 months ago
JSON representation
Adapters for third party services (file system, github, etc.) to connect to the CodeVideo ecosystem.
- Host: GitHub
- URL: https://github.com/codevideo/codevideo-adapters
- Owner: codevideo
- License: mit
- Created: 2025-05-01T07:33:25.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-14T10:56:52.000Z (about 1 year ago)
- Last Synced: 2025-09-23T09:51:57.540Z (9 months ago)
- Language: TypeScript
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# codevideo-adapters
Adapters for third party services (file system, GitHub, etc.) to connect to the CodeVideo ecosystem.
Currently, all adapters are not web compatible and are meant to be used in Node.js environments.
## Usage - File System Adapter
Start your CodeVideo lesson with the exact same starting point as any existing codebase, by providing the path to the folder containing your code:
```ts
import { buildFileStructureFromRootFolder } from "@fullstackcraftllc/codevideo-adapters";
const fileStructure = await buildFileStructureFromRootFolder("/path/to/your/codebase");
// use fileStructure in the initialSnapshot of your lesson
```
Returns a file structure of type [`IFileStructure`](https://github.com/codevideo/codevideo-types/blob/main/src/interfaces/IFileStructure.ts) from the `@fullstackcraftllc/codevideo-types` package.
## Usage - GitHub Adapter
Start your CodeVideo lesson at the exact file structure as a GitHub repository link.
Coming soon.