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

Config needs to not be required #58

Open
bradcypert opened this issue Oct 23, 2023 · 5 comments
Open

Config needs to not be required #58

bradcypert opened this issue Oct 23, 2023 · 5 comments
Labels
App Affecting or involving Steward's Application layer. enhancement New feature or request good first issue Good for newcomers

Comments

@bradcypert
Copy link
Contributor

We should try to find a config and if it doesn't exist, the app should fail gracefully.

This would be in the app package, as this is where the config loading takes place. This is likely just checking to see if the file exists before executing the code that loads it and maps items to config key-value pairs.

@bradcypert bradcypert added App Affecting or involving Steward's Application layer. enhancement New feature or request good first issue Good for newcomers labels Oct 23, 2023
@deepraj02
Copy link

hey @bradcypert this issue seems interesting, can you explain it a bit

@bradcypert
Copy link
Contributor Author

bradcypert commented Nov 9, 2023

@deepraj02 Currently when you use the steward app (test example) it tries to load your config file into the container (code). This line here assumes that the config file exists (code that needs to be modified) when it may not exist. We should check that the config file exists before executing this code, otherwise, we can just return early without doing the remainder of the code in that method.

@deepraj02
Copy link

Hey, I've started working on this projects, I'll be raising PR's and Issues as I find them.
For now I need some help regarding setting it up.

  1. how do you build the cli locally for testing.
  2. any specific command for running the steward app?

It'd be great if you could help me on these points.

@bradcypert

@deepraj02
Copy link

For what I've discovered the bin/ dir is for the CLI right? can I get a bit more detailed docs on these?
If you're okay with the idea of scheduling a meet let me know.

@bradcypert
Copy link
Contributor Author

bradcypert commented Nov 18, 2023

@deepraj02 The CLI is optional and not required to build or run a steward app. Its predominantly used to help scaffold out a project, but is not necessary for running the application. dart run on a dart file that imports steward should suffice. Copy/Pasting the example in the ReadMe should get you started. I will try to put together some more documentation for the CLI. Additionally, there is some more documentation here: https://pyrestudios.github.io/steward/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
App Affecting or involving Steward's Application layer. enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants