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

Improvement of setup docs in readme.md #82

Open
Ash-0803 opened this issue Sep 5, 2023 · 0 comments
Open

Improvement of setup docs in readme.md #82

Ash-0803 opened this issue Sep 5, 2023 · 0 comments

Comments

@Ash-0803
Copy link

Ash-0803 commented Sep 5, 2023

In the readme.md file, the setup docs is as follows :

Setup locally

  • Firstly download and install rabbitmq-server on your system. See here
  • Create .env
  • Make sure rabbitmq-server is running (default port 5672)

Start server.

  • npm start
  • For testing.
  • npm test

Which for me are a little vague!

  • It is said, to create .env file, but what should be the configuration and should we include anything?
  • I tried copying the .env.sample file but it didn't work. While running the server it is giving errors
  • Steps to clone the repo and npm i is also not mentioned in the docs.

Errors :
image

Solution :

  • There should be a detailed explaination of methods to setup the enviornment locally
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