https://github.com/vtex/my-subscriptions

Subscriptions app located inside My Account
https://github.com/vtex/my-subscriptions

my-account srv-store-framework subscriptions xp-post-purchase

Last synced: about 1 month ago
JSON representation

Subscriptions app located inside My Account

• Host: GitHub
• URL: https://github.com/vtex/my-subscriptions
• Owner: vtex
• Created: 2018-11-20T17:26:07.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T14:57:36.000Z (9 months ago)
• Last Synced: 2024-04-14T22:51:56.997Z (9 months ago)
• Topics: my-account, srv-store-framework, subscriptions, xp-post-purchase
• Language: TypeScript
• Homepage:
• Size: 2.85 MB
• Stars: 0
• Watchers: 100
• Forks: 2
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# My Subscriptions

- This is the monorepo that contains all the code related to rendering Subscriptions related information on the shopper my account page.

For more info about the MyAccount page itself, please check the [app repository](https://github.com/vtex-apps/my-account).

## List of Apps

| APP                                | URL                                                                                              | Description                                                   |

| ---------------------------------- | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------- |

| [email protected]                | [v3](https://github.com/vtex-apps/my-subscriptions/apps/vtex-my-subscriptions-3/)                | App responsible for the subscriptions pages inside MyAccount. |

| [email protected] | [v0](https://github.com/vtex-apps/my-subscriptions/apps/vtex-my-subscriptions-portal-connector/) | Auxiliary app used to display the app on Portal stores.       |

## Git Secret

This repository uses [git secret](#https://git-secret.io/).

To get access to the encrypted code:

1. Generate a gpg key: `gpg --gen-key`

2. Get your public key : `gpg --armor --export [email protected] > mykey.asc`

3. Send your key to an admin

## Development

### Developing

Some of the files used inside the `apps/vtex-my-subscriptions-3` are encrypted, before linking it to test your changes you have to:

1. run `git secret reveal` \*\* You will need the git secrets tooll installed and ask for one of the repo`s admin to add your public key to the ring.

2. run `vtex link`

### Adding a new user to the secrets ring

1. Ask for the requester to generate a public key as mentionend on the ## Git Secrets section.

2. Import the public key using `gpg --import NAME_OF_THE_FILE` \*\* `gpg` is required for this to work.

3. Add the requester to the key ring using `git secret tell REQUESTER_EMAIL` \*\* the email needs to be the same used to generate the key.

4. Encrypt the file again with the new entries using `git secret hide`.

5. Save the changes to the repo.

### Deploying a new version

This repo doesn't use the VTEX I/O CI/CD bot, because its an monorepo.

1. Go to the folder of the desired app. `cd apps/...`

2. Use the releasy tool to generate a new version of your app respecting the SEMVER. `releasy patch/minor/major` [releasy](https://github.com/vtex/releasy)

3. Publish it. `vtex publish --public`

4. Test the new version. Runing `vtex install AAP@VERSION` on your test account.

5. Deploy `vtex deploy`

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
Felipe Sales
💻 📖

    
Christian Kaisermann
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!