https://github.com/ffex/PodBook

An Appwrite Demo To transcript a podcast
https://github.com/ffex/PodBook

Last synced: 2 months ago
JSON representation

An Appwrite Demo To transcript a podcast

• Host: GitHub
• URL: https://github.com/ffex/PodBook
• Owner: ffex
• License: mit
• Created: 2022-10-30T20:06:39.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-04T16:43:38.000Z (about 2 years ago)
• Last Synced: 2024-08-02T07:23:20.844Z (5 months ago)
• Language: TypeScript
• Size: 2.43 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-appwrite - Source Code

README

        
![pod-book](cover.png)

# 💬 pod-book

> Do you want read a podcast?

pod-book is a webapp usefull to transcript instantly every podcast to read it or simply to follow better!

The only thing to do is to paste a rss url link, choose the episode and wait the transcription!

This application came into existance as a way to showcase amazing project that can be built using [Appwrite](https://appwrite.io/).

## 🧰 Tech Stack

- [Appwrite](https://appwrite.io/)

- [Deepgram](https://deepgram.com/)

- [Angular](https://angular.io/)

- [PrimeNG](https://www.primefaces.org/primeng/)

## 🛠️ Setup

1. Setup [Appwrite](https://appwrite.io/) 1.0.3

2. Create project with ID `transcriptions`

3. In Appwrite project page click on `Add Platform` and add a  `Web App` to avoid CORS errors.

4. Use [Appwrite CLI](https://appwrite.io/docs/command-line), all inside `backend` folder:

    

    4.1. (Optional, default: "`http://localhost/v1`") Setup Appwrite Endpoint: `appwrite client --endpoint [YOUR_APPWRITE_ENDPOINT]`

    4.2. Login to the server `appwrite login`, put your email and password.

    4.3. Run `appwrite deploy function --all`.

5. Create `Internal` API key (give all scopes), and configure `APPWRITE_FUNCTION_API_KEY` and `APPWRITE_FUNCTION_ENDPOINT` on every functions

6. Configure `DEEPGRAM_SECRET_KEY` with the Deepgram API key in every functions

7. Assign permissions `any` in every functions

8. Configure Angular Service: in `src/app/services/appwrite.service.ts` set `APPWRITE_ENDPOINT` var.

## 🏠 Development

1. Install dependencies `npm install`

2. Start Angular server `ng serve`

## 🖼️ Screenshots

![Screenshot](screenshots/ss1.png)

![Screenshot](screenshots/ss2.png)

![Screenshot](screenshots/ss3.png)

![Screenshot](screenshots/ss4.png)

![Screenshot](screenshots/ss5.png)

![Screenshot](screenshots/ss6.png)

![Screenshot](screenshots/ss7.png)

## 🤖 Angular Generated Documentation

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 14.2.6.

## Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The application will automatically reload if you change any of the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

## Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

## Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

## Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.