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

Fix documentation and developer setup/script #1490

Closed
8 of 9 tasks
egdmrsy opened this issue Oct 23, 2023 · 0 comments · Fixed by #1492
Closed
8 of 9 tasks

Fix documentation and developer setup/script #1490

egdmrsy opened this issue Oct 23, 2023 · 0 comments · Fixed by #1492
Assignees
Labels
api Indicates api related issue or feature blockchain Indicates blockchain related issue or feature bug Something isn't working frontend Indicates frontend related issue or feature

Comments

@egdmrsy
Copy link
Contributor

egdmrsy commented Oct 23, 2023

  • I have searched the issues of this repository and believe that this is not a duplicate.

Description 😯

Problems to address:

  • Go to Github and click on the documentation linked
    • TB Link to documentation points to wrong url
  • Navigate to the Developer Setup Guide
    • Write clear description about the environment variables
    • Make sure all folders contain .env.example and fix typos in file naming (blockchain)
    • Remove .env file in frontend
    • Fix markdown describing the environment variables (blockchain)
    • Complete the .env.examples
  • Executing script to start development
    • "sh scripts/development/start-dev.sh --slim" doesn't use the environment variables set before (because it uses its own .env files)
    • API crashes Error: "Cannot find module '/home/node/dist/lib/logger'" using the .env.example within the script folder
@egdmrsy egdmrsy added the bug Something isn't working label Oct 23, 2023
@egdmrsy egdmrsy self-assigned this Oct 23, 2023
@issuelabeler issuelabeler bot added api Indicates api related issue or feature blockchain Indicates blockchain related issue or feature frontend Indicates frontend related issue or feature labels Oct 23, 2023
@egdmrsy egdmrsy added this to the TruBudget 2.5.0 milestone Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Indicates api related issue or feature blockchain Indicates blockchain related issue or feature bug Something isn't working frontend Indicates frontend related issue or feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants