Skip to content

jrcapicua/voice-assistant-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Server – Voice Assistant Backend

This project is the backend for the Voice Assistant application. It is built with Node.js, Express, and TypeScript. It exposes endpoints to process audio and handle the voice assistant logic.

Features

  • RESTful API for voice processing.
  • Audio file handling using Multer.
  • Data validation with Zod.
  • Integration with groq-sdk for advanced processing.
  • Error handling middleware.

Requirements

  • Node.js >= 18.x
  • npm >= 9.x

Installation

npm install

Available Scripts

  • npm run dev – Starts the server in development mode with auto-reload.
  • npm run build – Compiles the TypeScript project to JavaScript.
  • npm start – Runs the server in production mode (requires prior build).

Main Dependencies

Folder Structure

  • src/ – Main source code.
  • src/controllers/ – Route controllers.
  • src/routes/ – API route definitions.
  • src/middlewares/ – Custom middlewares.
  • src/schemas/ – Validation schemas.
  • src/utils/ – Utilities and external clients.
  • src/config/ – App configuration.

Usage

  1. Install dependencies:

    npm install
  2. Start the server in development mode:

    npm run dev

    The server will listen by default at http://localhost:3000.

  3. For production:

    npm run build
    npm start

Notes

  • Make sure to configure any required environment variables in a .env file if needed.
  • This backend is intended to be consumed by the frontend located in the client/ folder.

About

This project is the backend for the Voice Assistant application.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published