README.md

Speech Companion

Project live link:

balayokesh.github.io/speech-companion

Made with:

---

To run project locally:

1. Download code from github

git clone https://github.com/balayokesh/speech-companion.git

2. Change directory

cd speech-companion

3. Install dependencies and start project

npm i 

4. Run project

npm start

(or)

Using Docker:

You can also run the project as a Docker Container.

1. Download code from github

git clone https://github.com/balayokesh/speech-companion.git

2. Build the Docker image

docker build -t speech-companion .

3. Run the Docker container locally

docker run --name speech-companion -p 8080:3000 -d speech-companion

With your container running, you can now visit your application by navigating your browser to http://localhost:8080

---

Contributions:

Please read contribution guide before proceeding.

Contributors: