diff --git a/README.md b/README.md index 4de49ac..e79f6da 100644 --- a/README.md +++ b/README.md @@ -9,21 +9,29 @@ use it now @ [www.androidapptranslator.com](https://androidapptranslator.com) ![Demo](documentation/demo/demo.gif) -## Available Scripts -In the project directory, you can run: +## Up an running locally -### `npm start` +### Generating Google Cloud Translation API Key +To get ReactAnuvaad up and running locally, you'll need to create and add a Google API key to enable usage of cloud translation API. +Follow this guide to create a new Google Cloud project and creating an auth API key +https://cloud.google.com/translate/docs/basic/setup-basic -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +### Using the API key in ReactAnuvaad + - Create a new file named `.env` in the project root. + - Create a new variable containing the API key + ``` + REACT_APP_LANG_TRANSLATION_API_KEY= + ``` + - Use the created variable in [LangUtils.ts](https://github.com/swapnil1104/ReactAnuvaad/blob/master/src/components/utils/LangUtils.ts) file. -### `npm run build` +After this, ReactAnuvaad is ready to run locally using the following steps: -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. +### Available Scripts -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! +In the project directory, you can run: -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +### `npm start` + +Runs the app in the development mode.
+Open [http://localhost:3000](http://localhost:3000) to view it in the browser.