Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update instructions on testing cards generation locally #53

Merged
merged 2 commits into from Jun 20, 2023

Conversation

takanome-dev
Copy link
Contributor

What type of PR is this? (check all applicable)

  • πŸ• Feature
  • πŸ› Bug Fix
  • πŸ“ Documentation Update
  • 🎨 Style
  • πŸ§‘β€πŸ’» Code Refactor
  • πŸ”₯ Performance Improvements
  • βœ… Test
  • πŸ€– Build
  • πŸ” CI
  • πŸ“¦ Chore (Release)
  • ⏩ Revert

Description

This pr:

  • adds .env.example mentioned in the readme but does not exist in the project
  • updates the path where social cards are stored after local generation. It's mentioned that they are in dist/local-dev but you'll find them in the dist folder after running the scripts
  • adds .filter(Boolean) in user-card.service.ts/getUserData. When generating a social card using my username, it works fine on prod and beta but crashes on dev because the repos array contains some null values.
  • updates readme on how to generate different social cards

Related Tickets & Documents

Fixes #48

Mobile & Desktop Screenshots/Recordings

Added tests?

  • πŸ‘ yes
  • πŸ™… no, because they aren't needed
  • πŸ™‹ no, because I need help

Added to documentation?

  • πŸ“œ README.md
  • πŸ““ docs.opensauced.pizza
  • πŸ• dev.to/opensauced
  • πŸ“• storybook
  • πŸ™… no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congrats on making your first Pull Request and thanks for taking the time to improve Open Sauced! ❀️! πŸŽ‰πŸ•
Say hello by joining the conversation in our Discord

@brandonroberts brandonroberts merged commit e152d09 into open-sauced:beta Jun 20, 2023
5 checks passed
@brandonroberts
Copy link
Contributor

Thanks @takanome-dev πŸ•

github-actions bot pushed a commit that referenced this pull request Jun 20, 2023
## [2.2.0-beta.2](v2.2.0-beta.1...v2.2.0-beta.2) (2023-06-20)

### πŸ“ Documentation

* update instructions on testing cards generation locally ([#53](#53)) ([e152d09](e152d09))
@github-actions
Copy link

πŸŽ‰ This PR is included in version 2.2.0-beta.2 πŸŽ‰

The release is available on:

Your semantic-release bot πŸ“¦πŸš€

github-actions bot pushed a commit that referenced this pull request Jun 20, 2023
## [2.2.0](v2.1.1...v2.2.0) (2023-06-20)

### πŸ› Bug Fixes

* remove issue templates ([#49](#49)) ([778ad4e](778ad4e))

### πŸ• Features

*  insights social card generation ([#51](#51)) ([8a82a48](8a82a48))

### πŸ“ Documentation

* update instructions on testing cards generation locally ([#53](#53)) ([e152d09](e152d09))
@github-actions
Copy link

πŸŽ‰ This PR is included in version 2.2.0 πŸŽ‰

The release is available on:

Your semantic-release bot πŸ“¦πŸš€

@takanome-dev takanome-dev deleted the 48-update-docs branch June 20, 2023 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: project readme needs updating
2 participants