Skip to content

Latest commit

 

History

History
52 lines (35 loc) · 786 Bytes

CONTRIBUTING.md

File metadata and controls

52 lines (35 loc) · 786 Bytes
Raw

🤖 Contributing to Refreshly 💗

See an issue or need that you're able to fulfill? Then this is the perfect place for you!

Prerequisites

  • NodeJS 18

Setting Up Locally

  • Install the Dependencies
$ yarn

Run the tests~

$ yarn test

Manually testing locally

  • Create a .env file
# For GitLab.Source & GitLab.Target
GITLAB_TOKEN=<gitlab-token>

# For GitHub.Target
GITHUB_TOKEN=<github-token>

# For AWS.Source
AWS_ACCESS_KEY_ID=<aws-access-key>
AWS_SECRET_ACCESS_KEY=<aws-secret-access-key>
  • In one terminal start the watch script
# This will recompile the modules anytime the code changes
$ yarn watch
  • In another terminal start the demo
# This runs the demo only once
$ yarn start