Skip to content

Greenstand/treetracker-wallet-app

Repository files navigation

Treetracker Wallet App: Secure and Easy Token Management

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.

Project Structure:

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:

  • apps/native: This directory contains the React Native code for the mobile app.

  • apps/web: This directory holds the Next.js code for the web app.

  • packages/core: This shared folder contains the core model layer, accessible by both the mobile and web apps.

Getting Started:

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

  1. Clone the repository: Use git clone https://github.com/Greenstand/treetracker-wallet-app to grab the code.

  2. Install dependencies: Run yarn in the main project directory to install all the necessary tools.

  3. Start Development Server (Choose your platform):

  • 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.

  • Mobile App: Head to the native directory and run yarn start. This starts the Expo development server for your mobile app.

Changelog

We use Conventional Changelog to generate our changelog. This means that all changes should be committed using the Conventional Commits format.

Here are some examples of commit messages and how they would appear in the changelog:

  • feat: A new feature Commit message: feat: add support for token transfers

  • fix: A bug fix Commit message: fix: prevent token balance from being negative

  • docs: An update to documentation Commit message: docs: add instructions for contributing

Contributing:

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

  • Found a bug or have an idea? Open an issue on our GitHub repository.

  • Want to add code? Fork the repository, make your changes, and submit a pull request.

  • Testing and Documentation Matter: Ensure your code is well-tested and adheres to our coding standards before submitting.

Thank You!

We appreciate your interest in contributing to Treetracker. Your time and effort are invaluable in making this project even better!

For further details, explore the individual project READMEs: