-
Notifications
You must be signed in to change notification settings - Fork 49
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: fix the lint-staged and prettier (#310)
- Loading branch information
1 parent
940a9a2
commit 8100cd9
Showing
68 changed files
with
1,194 additions
and
1,275 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
yarn pre-commit | ||
yarn lint-staged |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,201 +1,64 @@ | ||
# 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. | ||
- **`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. | ||
|
||
|
||
|
||
|
||
|
||
|
||
- **`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. | ||
- **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. | ||
|
||
|
||
|
||
* **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](https://github.com/conventional-changelog/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` | ||
- **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` | ||
|
||
|
||
|
||
|
||
|
||
- **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. | ||
|
||
|
||
- **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. | ||
|
||
|
||
|
||
|
||
|
||
|
||
- **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:** | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
* Web App: [Web README](apps/web/README.md) | ||
|
||
|
||
|
||
|
||
|
||
* Mobile App: [Native README](apps/native/README.md) | ||
|
||
|
||
- Web App: [Web README](apps/web/README.md) | ||
|
||
- Mobile App: [Native README](apps/native/README.md) | ||
|
||
* Core Model Layer: [Packages README](packages/core/README.md) | ||
- Core Model Layer: [Packages README](packages/core/README.md) |
Oops, something went wrong.