|
1 | 1 | # Treetracker Wallet App: Secure and Easy Token Management
|
2 | 2 |
|
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. |
4 | 6 |
|
5 | 7 | ## **Project Structure:**
|
6 | 8 |
|
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: |
8 | 12 |
|
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. |
10 | 15 |
|
11 | 16 | - **`apps/web`:** This directory holds the Next.js code for the web app.
|
12 | 17 |
|
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. |
14 | 20 |
|
15 | 21 | ## **Getting Started:**
|
16 | 22 |
|
17 | 23 | Excited to dive in? Here's how to get up and running:
|
18 | 24 |
|
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. |
20 | 28 |
|
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. |
22 | 31 |
|
23 | 32 | 3. **Start Development Server (Choose your platform):**
|
24 | 33 |
|
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. |
26 | 37 |
|
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. |
28 | 40 |
|
29 | 41 | ## **Changelog**
|
30 | 42 |
|
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. |
32 | 47 |
|
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: |
34 | 50 |
|
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` |
37 | 53 |
|
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` |
40 | 56 |
|
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` |
43 | 59 |
|
44 | 60 | ## **Contributing:**
|
45 | 61 |
|
46 | 62 | We value your input! Here's how to contribute:
|
47 | 63 |
|
48 | 64 | - **Found a bug or have an idea?** Open an issue on our GitHub repository.
|
49 | 65 |
|
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. |
51 | 68 |
|
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. |
53 | 71 |
|
54 | 72 | **Thank You!**
|
55 | 73 |
|
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! |
57 | 76 |
|
58 | 77 | **For further details, explore the individual project READMEs:**
|
59 | 78 |
|
|
0 commit comments