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

Create a step-by-step wizard script #61

Open
Ivansete-status opened this issue Feb 23, 2024 · 0 comments
Open

Create a step-by-step wizard script #61

Ivansete-status opened this issue Feb 23, 2024 · 0 comments

Comments

@Ivansete-status
Copy link
Contributor

The idea came from @jakubgs during a Waku Workshop session

Notes taken by @chair28980 , who hosted the workshop:

  • It might make sense to have an entrypoint script like run.sh, then the script will give them actions to take step-by-step
    • rather than require to update the .env
    • can also include which ports to use
      • 80 and 8000 should not be used
  • Jakub wizard script example:
    • In status-go https://github.com/status-im/status-go/blob/develop/MAILSERVER.md
    • entrypoint doc
    • Sets everything up for you
    • in assets/compose/mailserver there are three files that setup status-go
    • wraps everything around a make target, dockercompose and make files automate everything and make the variables available
    • this can be inspiration for how to set up nwaku-compose
  • Some projects take the (ugly) option of putting everything in one container, it hides complexity from people, but more technical people don’t like it because its hard to modify.
  • Wizard script comment
    • don’t give people a lot of text to read
    • give them a starting point, link to other files
    • people should not be greeted by a wall of text, more links, more files, smaller individual documents
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant