https://github.com/miguelteixeiraa/code-voice-assistant

https://github.com/miguelteixeiraa/code-voice-assistant

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/miguelteixeiraa/code-voice-assistant
• Owner: miguelteixeiraa
• License: apache-2.0
• Created: 2022-10-12T01:10:05.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-20T21:10:25.000Z (about 2 years ago)
• Last Synced: 2023-03-30T03:03:31.835Z (almost 2 years ago)
• Language: TypeScript
• Size: 86.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Code Voice Assistant

## :computer: Requirements

-   pNPM [https://pnpm.io/pt/](https://pnpm.io/pt/)

-   NodeJs (v16) [https://nodejs.org/en/](https://nodejs.org/en/)

-   Python (v3.10) [https://www.python.org/downloads/](https://www.python.org/downloads/)

-   Docker (v20) [https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)

## :art: Development Documentation

-   Mycroft [https://mycroft-ai.gitbook.io/docs/](https://mycroft-ai.gitbook.io/docs)

-   VSCode API [https://code.visualstudio.com/api/references/vscode-api](https://code.visualstudio.com/api/references/vscode-api)

## :rocket: Development Setup

install **docker** following the instructions at

```bash

# https://docs.docker.com/desktop/install/

```

install **NodeJs** using a NodeJs Version Manager (NVM).

```bash

# installing nvm

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash

# inserting NVM in PATH

export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"

[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # this loads nvm

# install NodeJs version 16

nvm install v16

```

install **pNPM** to manage JavaScript packages

```bash

curl -fsSL https://get.pnpm.io/install.sh | sh -

# inserting pNPM in PATH

export PNPM_HOME="$HOME/.local/share/pnpm"

export PATH="$PNPM_HOME:$PATH"

```

install **python** following the instructions at

```bash

https://www.python.org/downloads

```

install **JavaScript** dependencies

```bash

pnpm i

```

install **python** dependencies

```bash

# create a local virtual python environment

python3 -m venv ./.pvenv

# activate the environment

source ./.pvenv/bin/activate

# install python required packages

pip install -r requirements.txt

```

## :coffee: VSCode development

...