From 1bb2843150bcc1071baab946778f893460a7082e Mon Sep 17 00:00:00 2001 From: Rajat Khanduri Date: Thu, 29 Dec 2022 22:53:09 +0530 Subject: [PATCH 1/3] fixed readme --- ..._logs2022-12-29T17_17_30_338Z-debug-0.log" | 0 README.md | 108 +++++++++++++++++- 2 files changed, 106 insertions(+), 2 deletions(-) create mode 100644 "C\357\200\272UsersAdministratorAppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" diff --git "a/C\357\200\272UsersAdministratorAppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" "b/C\357\200\272UsersAdministratorAppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md index 21a4159..d10c06b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,107 @@ -# com-dictionary +
+ +
-com-dictionary +# Community Dictionary: Build your vocabulary! + +JavaScript +React +Firebase + +## About + +Community Dictionary is a project focused on creating a community around people who are in need of a dictionary on the go. It lets general public to contribute in building a rich dictionary including slang and common phrases that we use in the day to day life. Rather than having a formal dictionalry, community dictionary provides you with day to day phrases and examples so that anyone can have a clear understanding. + + +# Set up + + +### Requirements + +- [React.js](https://reactjs.org/docs/getting-started.html) +- A Firebase account - [sign up](https://console.firebase.google.com/) + + +### Local development + +After the above requirements have been met: +

+ +1. Clone this repository and `cd` into it + +```bash +git clone https://github.com/scorelab/com-dictionary.git +cd com-dictionary/com-dict-client +``` +
+ +2. Install dependencies + +```bash +yarn install +``` +
+ +3. Setup Firebase Project + +Goto your Firebase Console and create a new project in Firebase Console. Then register a new web app. +Copy the **config data** from the config file which will look like this. +``` +apiKey: "firebase-api-key", +authDomain: "firebase-auth-domain", +databaseURL: "firebase-db-url", +projectId: "firebase-project-id", +storageBucket: "firebase-storage-bucket", +messagingSenderId: "firebase-messaging-id", +appId: "firebase-app-id" +``` +
+ +4. Setup Firebase Configuration + +Rename the `.env.sample` file into `.env` and add your previously copied Firebase configuration details there. (Only the relevant details.) +
+The final `.env` file will look like this. +
+``` +REACT_APP_FIREBASE_API_KEY=xxxxxxxxxxxxxxxxxxxxxxx +REACT_APP_FIREBASE_PROJECT_ID=your-project-id +REACT_APP_FIREBASE_MESSAGING_SENDER_ID=xxxxxxxxxxxxxxxx +REACT_APP_FIREBASE_APP_ID=x:xxxxxxxx:web:xxxxxxxxxxx +``` +
+ +5. Setup Firebase Realtime Database + +Goto `Cloud Firestore` section in your Firebase Console and create a database. Import `database.dump` file into Firebase Firestore. It will create dummy data for you to test. +
+
+ +5. Setup Firebase Authentication +
+Goto `Authentication` section in your Firebase Console and click on *Sign-in method* tab. Click on the pen icon in front of `Email/Password` and click enable. +
+
+ +7. Run the project + +```bash +yarn start +``` +
+ + + +## Contributing + +This project is open source and welcomes contributions. + +[Visit the project on GitHub](https://github.com/scorelab/com-dictionary) + +## License + +[MIT](http://www.opensource.org/licenses/mit-license.html) + +## Disclaimer + +No warranty expressed or implied. Software is as is. \ No newline at end of file From 5200fab9544ea9ea0b6c79fbfefa0794885256d7 Mon Sep 17 00:00:00 2001 From: Rajat Khanduri <38693805+wthrajat@users.noreply.github.com> Date: Fri, 30 Dec 2022 02:25:19 +0530 Subject: [PATCH 2/3] deleted garbage file --- ...ppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 "C\357\200\272UsersAdministratorAppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" diff --git "a/C\357\200\272UsersAdministratorAppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" "b/C\357\200\272UsersAdministratorAppDataLocalnpm-cache_logs2022-12-29T17_17_30_338Z-debug-0.log" deleted file mode 100644 index e69de29..0000000 From 658a3d8c4eed54c057edf9a228ebb33eb599a716 Mon Sep 17 00:00:00 2001 From: Rajat Khanduri <38693805+wthrajat@users.noreply.github.com> Date: Sat, 31 Dec 2022 00:19:53 +0530 Subject: [PATCH 3/3] Update README.md --- README.md | 33 ++++++++++++++++++--------------- 1 file changed, 18 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index d10c06b..9561d3e 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,27 @@ -
- -
+

+ +

-# Community Dictionary: Build your vocabulary! +#

Community Dictionary: Build your vocabulary!

-JavaScript -React -Firebase +

JavaScriptReact +Firebase

-## About +# About -Community Dictionary is a project focused on creating a community around people who are in need of a dictionary on the go. It lets general public to contribute in building a rich dictionary including slang and common phrases that we use in the day to day life. Rather than having a formal dictionalry, community dictionary provides you with day to day phrases and examples so that anyone can have a clear understanding. +Not your average formal dictionary! Community Dictionary is a dictionary for the community, by the community. This project focuses on creating a community around people who are in need of a dictionary on the go. It lets general public to contribute in building a rich dictionary including slangs and common phrases that we use in in our day-to-day life. Rather than having a formal dictionary, community dictionary provides you with day to day phrases and examples so that anyone can have a clear understanding. -# Set up +# Usage ### Requirements - [React.js](https://reactjs.org/docs/getting-started.html) -- A Firebase account - [sign up](https://console.firebase.google.com/) +- A [Firebase account](https://console.firebase.google.com/) +- NodeJS +- Yarn +- NPM ### Local development @@ -27,7 +29,7 @@ Community Dictionary is a project focused on creating a community around people After the above requirements have been met:

-1. Clone this repository and `cd` into it +1. Clone this repository and `cd` into the project ```bash git clone https://github.com/scorelab/com-dictionary.git @@ -44,7 +46,8 @@ yarn install 3. Setup Firebase Project -Goto your Firebase Console and create a new project in Firebase Console. Then register a new web app. +Goto your Firebase Console and create a new project in Firebase Console. +Register a new web app. Copy the **config data** from the config file which will look like this. ``` apiKey: "firebase-api-key", @@ -83,7 +86,7 @@ Goto `Authentication` section in your Firebase Console and click on *Sign-in met

-7. Run the project +7. Run the project (aka start your development server) ```bash yarn start @@ -104,4 +107,4 @@ This project is open source and welcomes contributions. ## Disclaimer -No warranty expressed or implied. Software is as is. \ No newline at end of file +No warranty expressed or implied. Software is as is.