Skip to content

Latest commit

 

History

History
139 lines (101 loc) · 4.65 KB

README.md

File metadata and controls

139 lines (101 loc) · 4.65 KB
Raw

Memorii Sync

Frame 1 (1)

Yet another simple and intuitive flashcard app to boost your memory. Memorii Sync is designed to be an easy-to-use flashcard application aimed at enhancing memory retention and facilitating efficient learning

Features

  • Offline syncing capabilities
  • In-app store with premade decks
  • Partial spaced repetition algorithm
  • Intuitive customizable deck creation

Development

Prerequisites

  • node v16.x.x
  • src/config/conf.ts file needs to be updated with user's config
  • google-services.json needs to be put in the root directory
  • Firebase project
  • Expo cli with an account logged in (https://docs.expo.dev/get-started/installation/)

Installation

npx expo install # install dependencies
npx expo prebuild --clean # cleans and generate the android dir
npx expo run:android # run the app in an emulator

Building the apk:

The apk should be created through the expo cli. For that, you must have an Expo account. Then go to: https://expo.dev/accounts/minkstudios/projects, and create a new project with the name memorii-sync.

By default, the google-services.json file is added to gitignore. So, it won't be uploaded to expo when you start the build process. There are 2 ways this can be avoided:

  1. Adding it as a secret. Check: https://docs.expo.dev/build-reference/variables/#how-to-upload-a-secret-file-and-use-it-in-my-app-config
  2. Removing the google-services.json from gitignore. This is the simplest way.
npm install -g eas-cli
eas login

eas init --id <id> # you can find the id in the expo dashboard after creating a new project
eas build -p android --profile preview

Generating SHA-1

cd android
./gradlew signingReport

For the google sign-in to work properly, you must copy the SHA-1 value from your expo project to your firebase project. You can find the expo project's SHA-1 under Project Settings > Credentials

Important eas commands

eas whoami
eas login

eas init --id <eas-project-id> # resets the id

Docs

Build Profile

A build profile is a named group of configurations that describes the necessary parameters to perform a certain type of build.

The JSON object under the build key can contain multiple build profiles, and you can name these build profiles whatever you like, F,ex: development, preview, and production

To run a build with a specific profile, execute eas build --profile <profile-name>. If you omit the --profile flag, EAS CLI will default to using the profile with the name production, if it exists.

Build profiles can extend another build profile using the extends key. For example, in the preview profile you may have "extends": "production". This will make the preview profile inherit the configuration of the production profile.

More: https://docs.expo.dev/build/eas-json/#development-builds

Automatic build versioning

One of the most frequent causes of app store rejections is submitting a build with a duplicate version number. This happens when a developer forgets to increment the version number before running a build.

EAS Build can manage automatically incrementing these versions for you if you opt into using the "remote" app version source. The default behavior is to use a "local" app version source, which means you control versions manually in their respective config files.

{
  "cli": {
    "appVersionSource": "remote"
  },
  "build": {
    "staging": {
      "distribution": "internal",
      "android": {
        "buildType": "apk"
      }
    },
    "production": {
      "autoIncrement": true
    }
  }
}

Firestore rules

rules_version = '2';

service cloud.firestore {
  match /databases/{database}/documents {
    // Public access to appInfo and market
    match /appInfo/{document=**} {
      allow read;
    }
    match /market/{document=**} {
      allow read;
    }

    // Access restrictions for users
    match /users/{userId} {
      // Allow only the current user to access their own document
      allow read, write: if request.auth != null && request.auth.uid == userId;
    }

    // Access control for decks
    match /decks/{deckId} {
      // Allow users to read decks only if they have purchased them
			allow read: if request.auth.uid != null 
                  && exists(/databases/$(database)/documents/users/$(request.auth.uid))
                  && deckId in get(/databases/$(database)/documents/users/$(request.auth.uid)).data.decksPurchased;
    }
  }
}

Issues faced