Convene Handbook

Thank you all for joining this project! I'm excited to see what we can build here. This readme will outline some ideas for how we can make this work, but remember, this is all up to change, and if you have any ideas on how to do something better I would love to hear them!

Convene Roadmap

• Make current code fully tested
• Add ratings and reviews for each book
• To be announced

Link to Figma Design: https://www.figma.com/file/pJE13ASCU1thA5lvosadv0/Convene?node-id=0%3A1

How this project will work?

Short answer is we will figure it out as we go, but I have created a starting point for something we can work with. If you think there is some way we can do things better, please let me know.

Proposals and Ideas

There is a template for proposals, use this for any idea or proposal for what you would like to see in the application. Or in the project in general.

• For every accepted proposal, 1 point will be rewarded.

Tasks

The workflow for accomplishing tasks should look like this:

1. Select task you want to work on
2. Assign it to yourself
3. Complete the task
4. Create a pull request
5. Wait for 2 reviewers to code review your task

Rules:

• If your code is blocking other people work, need to give daily updates as a comment on the issue, or it will be assigned to someone else.

Code Reviews

Code reviewers will be expected to assign themselves to any code reviews that they deem capable of reviewing. Once you selected the code to review, assign yourself as a reviewer and you will have 24 hours to complete the code review.

• Reviewer gets 1 point for finding a bug during a review

Total point summary

Task Type	Task	Points
AP	Accepted Proposal	1
BF	Bug Found (during review)	1
LF	Large Feature	4
MF	Medium Feature	3
SF	Small Feature	2
LB	Large Bug Fix	3
MB	Medium Bug Fix	2
SB	Small Bug Fix	1

Current Points will be recorded in points.md, and must be updated during your task or by me for AP and BF.

All points are subject to change, and sometimes there might be tasks that will have to overrule the point system.

Firebase Emulator Configuration

There are many ways around for this the one which will be listed below is efficient in my POV.

Initialize a Firebase project

This step is important, if u already have an initialization ready with the emulators u can skip this.

Terminal

1. To get started create a folder backend (any applicable name would be fine) outside of the project.

mkdir backend && cd backend

2. run firebase login and login with your associated account. Skip if you are already logged in

3. run firebase init please follow the flow to initialize your project. From the first prompt make sure to select firestore and emulators. Once you reach the emulator prompt select the authentication,firestore (we can install others later if we require them).

After you have finished the initialization you will see a file called firebase.json you would see some thing like this

{
  "firestore": {
    "rules": "firestore.rules",
    "indexes": "firestore.indexes.json"
  },
  "emulators": {
    "auth": {
      "port": 9099
    },
    "firestore": {
      "port": 8080
    },
    "ui": {
      "enabled": true
    }
  },
  "storage": {
    "rules": "storage.rules"
  }
}

All the emulators will be by default pointing to your localhost.

In my case the default (localhost) configuration doesn't work for me. This default configuration will only work on emulators and simulators. To make it work for all devices we have to point the host to our network ip (your desktop ip).

{
  "firestore": {
    "rules": "firestore.rules",
    "indexes": "firestore.indexes.json"
  },
  "emulators": {
    "auth": {
      "host": "0.0.0.0",
      "port": 9099
    },
    "firestore": {
      "host": "0.0.0.0",
      "port": 8080
    },
    "ui": {
      "enabled": true
    }
  },
  "storage": {
    "rules": "storage.rules"
  }
}

Adding the host as 0.0.0.0 will set the emulators to your network ip ex. (192.168.8.131).

4. To start the emulators run firebase emulators:start

Setting it to Flutter Project

• create a folder configs in the root of the project with a file called emulator_config.json. You can skip this step if u have not changed hosts or ports

{
  "ip": "192.168.8.131",
  "auth_port": 9099,
  "firestore_port": 8080
}

• ip add this field if u have changed the port to your device ip, if this field is not there the app will by default use 10.0.2.2 for android and localhost for ios.
• auth_port your authentication port in the firebase.json, remove this if u have not changed your default ports.
• firestore_port your firestore port in the firebase.json. remove this if u have to changed the default ports

Starting the app

• If you are using vscode as your editor goto your debug panel , you will see two new launch configs

  1. Conveneapp Production this points to your original firebase project so running this will not connect to your firebase emulators
  2. Conveneapp Development running this will use the firebase emulators.

• If your are using other editors to make use of the firebase emulators your have to add the following as arguments for your --dart-define=ENV=DEV

• If you are using terminal flutter run --dart-define=ENV=DEV

If you start the app without the provided args this will point to your production database.