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

Add README with project overview and run instructions #199

Open
Farhad-Shabani opened this issue Jan 14, 2025 · 2 comments
Open

Add README with project overview and run instructions #199

Farhad-Shabani opened this issue Jan 14, 2025 · 2 comments
Assignees
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@Farhad-Shabani
Copy link
Member

Farhad-Shabani commented Jan 14, 2025

As it currently stands, the project looks quite bare from the outside; it's not clear what the goals of the project are or how to get started with it. Even from the inside, the bare state of the project makes onboarding onto it challenging. Getting it running will require going over the code and integration tests themselves, as well as a fair bit of trial-and-error.

Our integration tests are designed to test the entire stack together - including the Cairo contracts, CW light client, and relayer - any changes made to one part of the project must be reflected to the others. This is because of the existing Nix setup. Thus, it’s essential for everyone to learn how to run the whole stack and the CI jobs locally. This entails:

  1. Setting up the requisite chain binaries locally, preferably using Nix
  2. Declaring and deploying contracts on both chains through the user's local machine
  3. Running the relayer, preferably using Nix, to send packets via the relayer's CLI and run the integration tests locally

Add a README that includes:

  • An overview of the project, briefly explaining what it does and how different parts come together.
  • Instructions on how to run the project, including any prerequisites or setup steps, as outlined above.
@Farhad-Shabani Farhad-Shabani added the documentation Improvements or additions to documentation label Jan 14, 2025
@rnbguy
Copy link
Member

rnbguy commented Jan 14, 2025

I second this. I always face difficulty with running the Cairo tests.

@soareschen
Copy link
Collaborator

Perhaps this would be a good onboarding for @seanchen1991

@Farhad-Shabani Farhad-Shabani added this to the MVP Demo #2 milestone Jan 15, 2025
@seanchen1991 seanchen1991 modified the milestones: MVP Demo #2, Phase 3+ Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants