Skip to content

Commit

Permalink
chore: fix the lint-staged and prettier (#310)
Browse files Browse the repository at this point in the history
  • Loading branch information
pierrelstan authored Dec 22, 2024
1 parent 940a9a2 commit 8100cd9
Show file tree
Hide file tree
Showing 68 changed files with 1,194 additions and 1,275 deletions.
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
title: ""
labels: bug
assignees: ''

assignees: ""
---

**Describe the bug**
Expand Down Expand Up @@ -37,4 +36,4 @@ If applicable, add screenshots to help explain your problem.
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
Add any other context about the problem here.
19 changes: 15 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
<!--
---
## <!--

name: "Monorepo Contribution"
about: "Template for contributions in a monorepo with apps and packages folders"
title: "[Feature/Bug] - Title"
labels: ["contribution"]
assignees: "" # Leave blank if no specific assignee
assignees: "" # Leave blank if no specific assignee

---

-->

### Description

Please provide a clear and concise description of the changes made, including the purpose and context.

**Fixes**: # (issue number)
Expand All @@ -18,7 +21,9 @@ or
---

### Changes Made

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

- [ ] `Web`
- [ ] `Native`

Expand All @@ -28,6 +33,7 @@ or
---

### Type of Change

- [ ] 🐛 **Bug fix** (non-breaking change which fixes an issue)
- [ ]**New feature** (non-breaking change which adds functionality)
- [x] 💥 **Breaking change** (fix or feature that would cause existing functionality to not work as expected)
Expand All @@ -36,19 +42,23 @@ or
---

## Screenshots

| Before | After |
| :-----------------: | :----------------: |
| "screenshot before" | "screenshot after" |

---

### How Has This Been Tested?

- [ ] Cypress integration
- [ ] Cypress component tests
- [ ] Jest unit tests

---

### Checklist:

- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
Expand All @@ -60,4 +70,5 @@ or
---

### Additional Comments
*(Optional) Add any additional comments or notes for reviewers here.*

_(Optional) Add any additional comments or notes for reviewers here._
4 changes: 2 additions & 2 deletions .github/workflows/api-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ on:
branches:
- "*"
paths:
- 'apps/user/**' # Only trigger for changes in the apps/user directory
- "apps/user/**" # Only trigger for changes in the apps/user directory

jobs:
test:
Expand All @@ -16,7 +16,7 @@ jobs:
- name: Use Node.js 18.x
uses: actions/setup-node@v3
with:
node-version: '18.x'
node-version: "18.x"

- name: Install dependencies for specific package
run: yarn workspace greenstand-wallet-app-api install
Expand Down
8 changes: 3 additions & 5 deletions .github/workflows/build-dev-docker-img-and-relase.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
name: Service CI/CD Pipeline to Release and Deploy to Dev Env


on:
push:
branches:
- main
paths:
- 'apps/user/**' # Only trigger for changes in the apps/user directory
- "apps/user/**" # Only trigger for changes in the apps/user directory

jobs:
release:
Expand All @@ -20,7 +19,7 @@ jobs:
- name: Use Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: '20.x'
node-version: "20.x"

- name: Yarn Clean Install
run: yarn workspace greenstand-wallet-app-api install
Expand Down Expand Up @@ -54,12 +53,11 @@ jobs:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}


- name: Build and Push Docker Image
id: docker_build_release
uses: docker/build-push-action@v5
with:
context: ./apps/user/
context: ./apps/user/
file: ./apps/user/Dockerfile
push: true
tags: greenstand/treetracker-wallet-monorepo-user-api:${{ steps.package-version.outputs.current-version }}
Expand Down
2 changes: 1 addition & 1 deletion .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -1 +1 @@
yarn pre-commit
yarn lint-staged
171 changes: 17 additions & 154 deletions README.md
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)
Loading

0 comments on commit 8100cd9

Please sign in to comment.