Skip to content

Improvement of setup docs in readme.md #82

Description

@Ash-0803

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions