Welcome to Parrot, an open source project exploring the possibilities of using web technologies for learning languages and speech recognition.
Before you get started with local development you'll need to install and configure a few tools and services.
The simplest way to do this is using Volta, a tool the helps manage node and yarn. You can find instructions on how to do that here: https://volta.sh/
For local development we need a local instance of MongoDB, instructions available here: https://docs.mongodb.com/manual/installation/
*Note: If you wish you can use an instance of MongoDB Atlas, a cloud hosted version of MongoDB. https://www.mongodb.com/cloud/atlas?tck=docs_server
In your .env file (see example for required variables) you'll need to provide a service account key. Follow the instrustions here: https://cloud.google.com/translate/docs/setup
This step is optional, you can use any HTTP client you like for testing endpoints. However, I use Insomnia: https://insomnia.rest/
Simply download the app and then import insomnia-workspace.json into the it.
We're using yarn to manage packages so once you've cloned this repository (and followed the steps above) simple run the following command in the repo directory:
yarn
To start up the local development server run:
yarn dev
The server will then be running on http://localhost:3000 with a hot reloading client up running on http://localhost:3002
If you want to work on front end components, without starting the server run:
yarn docs
This will start an instance of Storybook running on http://localhost:3001, without the server running. To add a new story, add a file to /docs called Component.docs.jsx. More information on using Storybook here: https://storybook.js.org/