Skip to content

Commit 9c91257

Browse files
authored
Merge branch 'main' into login-page
2 parents 7bb6659 + 5b390d9 commit 9c91257

19 files changed

+336
-202
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+8-13
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,17 @@ labels: bug
66
assignees: ""
77
---
88

9-
**Describe the bug**
10-
A clear and concise description of what the bug is.
9+
**Describe the bug** A clear and concise description of what the bug is.
1110

12-
**To Reproduce**
13-
Steps to reproduce the behavior:
14-
(we recommend record a screenshot to show the case, like using http://loom.com to record)
11+
**To Reproduce** Steps to reproduce the behavior: (we recommend record a
12+
screenshot to show the case, like using http://loom.com to record)
1513

16-
**Expected behavior**
17-
A clear and concise description of what you expected to happen.
14+
**Expected behavior** A clear and concise description of what you expected to
15+
happen.
1816

19-
**Screenshots**
20-
If applicable, add screenshots to help explain your problem.
17+
**Screenshots** If applicable, add screenshots to help explain your problem.
2118

22-
\*\* Node.js version
23-
(The node version on your computer to run the project)
19+
\*\* Node.js version (The node version on your computer to run the project)
2420

2521
**Desktop (please complete the following information):**
2622

@@ -35,5 +31,4 @@ If applicable, add screenshots to help explain your problem.
3531
- Browser [e.g. stock browser, safari]
3632
- Version [e.g. 22]
3733

38-
**Additional context**
39-
Add any other context about the problem here.
34+
**Additional context** Add any other context about the problem here.

.github/pull_request_template.md

+15-13
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
1-
## <!--
1+
<!--
22
3-
name: "Monorepo Contribution"
4-
about: "Template for contributions in a monorepo with apps and packages folders"
5-
title: "[Feature/Bug] - Title"
6-
labels: ["contribution"]
7-
assignees: "" # Leave blank if no specific assignee
3+
name: "Monorepo Contribution" about: "Template for contributions in a monorepo
4+
with apps and packages folders" title: "[Feature/Bug] - Title" labels:
5+
["contribution"] assignees: "" # Leave blank if no specific assignee
86
97
---
108
119
-->
1210

13-
### Description
11+
# Description
1412

15-
Please provide a clear and concise description of the changes made, including the purpose and context.
13+
Please provide a clear and concise description of the changes made, including
14+
the purpose and context.
1615

1716
**Fixes**: # (issue number)
1817
or
1918
**Resolves**: # (issue number)
2019

2120
---
2221

23-
### Changes Made
22+
## Changes Made
2423

25-
- [ ] Changes in **`apps`** folder (specify the app and briefly describe the changes):
24+
- [ ] Changes in **`apps`** folder (specify the app and briefly describe the
25+
changes):
2626

2727
- [ ] `Web`
2828
- [ ] `Native`
2929

30-
- [ ] Changes in **`packages`** folder (specify the package and briefly describe the changes):
30+
- [ ] Changes in **`packages`** folder (specify the package and briefly describe
31+
the changes):
3132
- [ ] `Core`
3233

3334
---
@@ -36,12 +37,13 @@ or
3637

3738
- [ ] 🐛 **Bug fix** (non-breaking change which fixes an issue)
3839
- [ ]**New feature** (non-breaking change which adds functionality)
39-
- [x] 💥 **Breaking change** (fix or feature that would cause existing functionality to not work as expected)
40+
- [ ] 💥 **Breaking change** (fix or feature that would cause existing
41+
functionality to not work as expected)
4042
- [ ] 📝 **Documentation update** (changes)
4143

4244
---
4345

44-
## Screenshots
46+
#### Screenshots
4547

4648
| Before | After |
4749
| :-----------------: | :----------------: |

.github/workflows/lint-format.yml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Lint & Commit Check
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
lint-format:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
17+
- name: Set up Node.js
18+
uses: actions/setup-node@v4
19+
with:
20+
node-version: "20.x"
21+
cache: "yarn"
22+
23+
- name: Install dependencies
24+
run: yarn install --frozen-lockfile
25+
26+
- name: Run Prettier Check
27+
run: yarn prettier --check .
28+
29+
- name: Run Lint-Staged (Prettier & ESLint)
30+
run: yarn lint-staged
31+
32+
- name: Run Commitlint on Last Commit
33+
run: git log -1 --pretty=format:%s | npx --no -- commitlint

.prettierignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
bin

.prettierrc

+9-1
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,13 @@
55
"trailingComma": "all",
66
"useTabs": false,
77
"tabWidth": 2,
8-
"singleQuote": false
8+
"singleQuote": false,
9+
"overrides": [
10+
{
11+
"files": "*.md",
12+
"options": {
13+
"proseWrap": "always"
14+
}
15+
}
16+
]
917
}

README.md

+38-19
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,78 @@
11
# Treetracker Wallet App: Secure and Easy Token Management
22

3-
**Greenstand** provides a secure and user-friendly platform for managing your digital tokens. Sending and receiving tokens takes just a few taps, making it a breeze to transfer them between users.
3+
**Greenstand** provides a secure and user-friendly platform for managing your
4+
digital tokens. Sending and receiving tokens takes just a few taps, making it a
5+
breeze to transfer them between users.
46

57
## **Project Structure:**
68

7-
Treetracker leverages a monorepo structure, meaning it houses multiple projects in a single repository. This allows for efficient code sharing across different platforms. Here's a breakdown:
9+
Treetracker leverages a monorepo structure, meaning it houses multiple projects
10+
in a single repository. This allows for efficient code sharing across different
11+
platforms. Here's a breakdown:
812

9-
- **`apps/native`:** This directory contains the React Native code for the mobile app.
13+
- **`apps/native`:** This directory contains the React Native code for the
14+
mobile app.
1015

1116
- **`apps/web`:** This directory holds the Next.js code for the web app.
1217

13-
- **`packages/core`:** This shared folder contains the core model layer, accessible by both the mobile and web apps.
18+
- **`packages/core`:** This shared folder contains the core model layer,
19+
accessible by both the mobile and web apps.
1420

1521
## **Getting Started:**
1622

1723
Excited to dive in? Here's how to get up and running:
1824

19-
1. **Clone the repository:** Use `git clone https://github.com/Greenstand/treetracker-wallet-app` to grab the code.
25+
1. **Clone the repository:** Use
26+
`git clone https://github.com/Greenstand/treetracker-wallet-app` to grab the
27+
code.
2028

21-
2. **Install dependencies:** Run `yarn` in the main project directory to install all the necessary tools.
29+
2. **Install dependencies:** Run `yarn` in the main project directory to
30+
install all the necessary tools.
2231

2332
3. **Start Development Server (Choose your platform):**
2433

25-
- **Web App:** Navigate to the `web` directory and run `yarn dev`. This launches the Next.js development server, accessible at http://localhost:3000 in your web browser.
34+
- **Web App:** Navigate to the `web` directory and run `yarn dev`. This launches
35+
the Next.js development server, accessible at http://localhost:3000 in your
36+
web browser.
2637

27-
- **Mobile App:** Head to the `native` directory and run `yarn start`. This starts the Expo development server for your mobile app.
38+
- **Mobile App:** Head to the `native` directory and run `yarn start`. This
39+
starts the Expo development server for your mobile app.
2840

2941
## **Changelog**
3042

31-
We use [Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog) to generate our changelog. This means that all changes should be committed using the Conventional Commits format.
43+
We use
44+
[Conventional Changelog](https://github.com/conventional-changelog/conventional-changelog)
45+
to generate our changelog. This means that all changes should be committed using
46+
the Conventional Commits format.
3247

33-
Here are some examples of commit messages and how they would appear in the changelog:
48+
Here are some examples of commit messages and how they would appear in the
49+
changelog:
3450

35-
- **feat:** A new feature
36-
Commit message: `feat: add support for token transfers`
51+
- **feat:** A new feature Commit message:
52+
`feat: add support for token transfers`
3753

38-
- **fix:** A bug fix
39-
Commit message: `fix: prevent token balance from being negative`
54+
- **fix:** A bug fix Commit message:
55+
`fix: prevent token balance from being negative`
4056

41-
- **docs:** An update to documentation
42-
Commit message: `docs: add instructions for contributing`
57+
- **docs:** An update to documentation Commit message:
58+
`docs: add instructions for contributing`
4359

4460
## **Contributing:**
4561

4662
We value your input! Here's how to contribute:
4763

4864
- **Found a bug or have an idea?** Open an issue on our GitHub repository.
4965

50-
- **Want to add code?** Fork the repository, make your changes, and submit a pull request.
66+
- **Want to add code?** Fork the repository, make your changes, and submit a
67+
pull request.
5168

52-
- **Testing and Documentation Matter:** Ensure your code is well-tested and adheres to our coding standards before submitting.
69+
- **Testing and Documentation Matter:** Ensure your code is well-tested and
70+
adheres to our coding standards before submitting.
5371

5472
**Thank You!**
5573

56-
We appreciate your interest in contributing to Treetracker. Your time and effort are invaluable in making this project even better!
74+
We appreciate your interest in contributing to Treetracker. Your time and effort
75+
are invaluable in making this project even better!
5776

5877
**For further details, explore the individual project READMEs:**
5978

apps/native/README.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,15 @@
22

33
==========================
44

5-
The Treetracker Wallet Mobile App is a user-friendly interface for managing digital tokens.
5+
The Treetracker Wallet Mobile App is a user-friendly interface for managing
6+
digital tokens.
67

78
### Overview
89

910
---
1011

11-
This app is built using Expo and React Native, and provides a secure and scalable way to manage digital tokens.
12+
This app is built using Expo and React Native, and provides a secure and
13+
scalable way to manage digital tokens.
1214

1315
### Features
1416

@@ -37,7 +39,8 @@ cd apps/native
3739
yarn start
3840
```
3941

40-
This will start the app in development mode, and you can access it by scanning the QR code with your Expo Go app.
42+
This will start the app in development mode, and you can access it by scanning
43+
the QR code with your Expo Go app.
4144

4245
### Testing
4346

@@ -47,7 +50,8 @@ This will start the app in development mode, and you can access it by scanning t
4750

4851
We use Maestro for testing of our app:
4952

50-
- **End-to-End Testing (E2E)**: Testing the entire application flow to ensure it works as expected, from start to finish.
53+
- **End-to-End Testing (E2E)**: Testing the entire application flow to ensure it
54+
works as expected, from start to finish.
5155

5256
```bash
5357
yarn maestro test

0 commit comments

Comments
 (0)