diff --git a/README.md b/README.md index 21a4159..9561d3e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,110 @@ -# com-dictionary +

+ +

-com-dictionary +#

Community Dictionary: Build your vocabulary!

+ +

JavaScriptReact +Firebase

+ +# About + +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. + + +# Usage + + +### Requirements + +- [React.js](https://reactjs.org/docs/getting-started.html) +- A [Firebase account](https://console.firebase.google.com/) +- NodeJS +- Yarn +- NPM + + +### Local development + +After the above requirements have been met: +

+ +1. Clone this repository and `cd` into the project + +```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. +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 (aka start your development server) + +```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.