wadiim / gengo

An Android application for learning kana and kanji written for a class project.

Gengo

An Android application for learning kana and kanji written for a class project.

Features

• Dark and light theme
• Customizable font size
• Authentication
• Profile pictures
• TalkBack support

Running

1. Create an account at https://firebase.google.com/.
2. Create a Firebase project.
3. Go to Project settings → General → Android, and register a new app with package name: com.example.gengo.
4. Click "Download google-services.json" and save the file at app/.
5. Go to Console → Storage → Get started → Click "Start in test mode" → Click "Next" → Choose storage location and click "Done". Then, create an images/ folder.
6. Go to Storage → Rules, and replace the default rules with the following:

   rules_version = '2';
   
   service firebase.storage {
     match /b/{bucket}/o {
       match /{allPaths=**} {
         allow read, write: if true;
       }
     }
   }
   

7. Go to Firestore Database and click "Start collection". Enter Users as Collection ID and click "Next". Then, add a new document with ID e.g. [e-mail] and a username field of type string and value Foo.
8. Go to Firestore Database → Rules, and replace the default rules with the following:

   rules_version = '2';
   
   service cloud.firestore {
     match /databases/{database}/documents {
       match /{document=**} {
         allow read, write: if true;
       }
     }
   }
   

9. Add Lessons collection with e.g. the following documents: Hiragana, Katakana, and Kanji - numbers. Populate the documents with fields as shown in the pictures below.
10. Go to All products → Authentication → Get started → Sign-in method. Select "Email/Password", and then enable only "Email/Password", and click "Save".
11. Build and run the application using e.g. Adroid Studio.

License

MIT