coding-blocks / coding-blocks/certificate-worker

Improvement of setup docs in readme.md

Open
#82 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Handlebars
Stars
3
Forks
24
PR merge metrics
No merged PRs in 30d

Description

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

**Setup locally**
- Firstly download and install rabbitmq-server on your system. [See here](https://www.rabbitmq.com/download.html)
- 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](https://github.com/coding-blocks/certificate-worker/assets/96429314/f172acb4-9291-4d29-b5aa-9c1159eb79c4)

Solution :

- There should be a detailed explaination of methods to setup the enviornment locally

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.