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

Backend readme #1470

Merged
merged 3 commits into from
Jan 29, 2024
Merged

Backend readme #1470

merged 3 commits into from
Jan 29, 2024

Conversation

Vayras
Copy link
Contributor

@Vayras Vayras commented Jan 27, 2024

This PR is focused on the updating the Readme to be backend focused only, issue #1463

@ecurrencyhodler
Copy link
Contributor

Thanks for submitting this. Documentation looks really nice.

Would you mind adding instructions to test locally as well?

@Vayras
Copy link
Contributor Author

Vayras commented Jan 28, 2024

Thanks for submitting this. Documentation looks really nice.

Would you mind adding instructions to test locally as well?

yeah will do that as well, where can I find a reference for that?

@Vayras
Copy link
Contributor Author

Vayras commented Jan 28, 2024

Thanks for submitting this. Documentation looks really nice.
Would you mind adding instructions to test locally as well?

@ecurrencyhodler yeah will do that as well, where can I find a reference for that?

@ecurrencyhodler
Copy link
Contributor

I think just direct them to install yarn. This is also what @MahtabBukhari recommended in the hunters tribe:

"Run the command 'yarn install'.

After that, execute 'yarn jest test-file-name'. As you run the command, an error will occur in the node module file. There are three files you have to open from the link shown with the error in the terminal. After opening each file, comment out the entire content.

Once you have commented out these three files, on the fourth attempt, you should be able to run the test locally."

@Vayras
Copy link
Contributor Author

Vayras commented Jan 28, 2024

I think just direct them to install yarn. This is also what @MahtabBukhari recommended in the hunters tribe:

"Run the command 'yarn install'.

After that, execute 'yarn jest test-file-name'. As you run the command, an error will occur in the node module file. There are three files you have to open from the link shown with the error in the terminal. After opening each file, comment out the entire content.

Once you have commented out these three files, on the fourth attempt, you should be able to run the test locally."

Sure, Adding these instructions right away, Thanks

@Vayras
Copy link
Contributor Author

Vayras commented Jan 28, 2024

@ecurrencyhodler quick question, as far as what I have learned we use jest for frontend testing and mockery for backend testing, so I think the instructions for setting up jest locally should be added to the frontend readme and not on this, let me know If I got that wrong.

@ecurrencyhodler
Copy link
Contributor

OOo good point. You're right. Let's get a review on your instructions from raph/kev and then merge.

```
MEME_URL=
```
Configure Redis by adding the `REDIS_URL` or other relevant variables to your `.env` file.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you specify the other relevant variables?

REDIS_HOST=
REDIS_USER=
REDIS_PASS=
REDIS_DB=

To make it easier for developers.

@Vayras
Copy link
Contributor Author

Vayras commented Jan 29, 2024

@elraphty yeah , will update this

@Vayras
Copy link
Contributor Author

Vayras commented Jan 29, 2024

@elraphty updated the readme

@@ -78,6 +77,14 @@ go build .

Configure Redis by adding the `REDIS_URL` or other relevant variables to your `.env` file.

```sh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is the sh for?

@Vayras
Copy link
Contributor Author

Vayras commented Jan 29, 2024

@elraphty it will format the text in a code block

@elraphty elraphty merged commit 5e2cc76 into stakwork:master Jan 29, 2024
4 checks passed
@ecurrencyhodler
Copy link
Contributor

good work. paid!

elraphty added a commit that referenced this pull request Jan 29, 2024
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

Successfully merging this pull request may close these issues.

3 participants