You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Remove contribution section from README
Removed contribution guidelines from README.
* Add contributing guidelines to CONTRIBUTING.md
Added guidelines for contributing to the project, including setup instructions for Firebase Emulator Suite and mobile app development.
* Create README.md
TwoAxis Finance is built entirely on Firebase, and the mobile client is built using Flutter.
4
+
5
+
## Running the Firebase Emulator Suite
6
+
In order to contribute, you must use the Firebase Emulator Suite.
7
+
8
+
- Make sure that you have Firebase Tools CLI installed: `npm install -g firebase-tools`
9
+
- Run Firebase emulators locally: `firebase emulators:start`
10
+
11
+
## Running the mobile app
12
+
- Open the `mobile/` directory in Android Studio (or IDE that supports Flutter).
13
+
- Run `main.dart` in development mode (`assembleDebug`)
14
+
15
+
Note: The mobile client connects to the Firebase Emulators in debug mode only (`kDebugMode`). You may change this in `lib/main.dart`, but do not commit your changes.
16
+
17
+
## Pull Requests
18
+
Your pull requests will be reviewed throughly, please submit many small pull requests rather than one big one.
19
+
Make sure to assign proper labels to your pull request as it will impact the review.
20
+
Include a description with your pull request that includes an overview of what the pull request changes.
Copy file name to clipboardExpand all lines: README.md
-6Lines changed: 0 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,6 @@ This project is open-source but currently has no license. This means:
20
20
- You **may** contribute to the project.
21
21
- You **may not** redistribute, modify, or rebrand the project without explicit permission.
22
22
23
-
### How to Contribute
24
-
1. Fork the repository.
25
-
2. Create a new branch for your feature or fix.
26
-
3. Commit and push your changes.
27
-
4. Submit a pull request for review.
28
-
29
23
## Website
30
24
Visit [finance.twoaxis.org](https://finance.twoaxis.org) for more details about the app. Note that there is no web version of TwoAxis Finance at this time.
0 commit comments