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

[Docs]: Improve README.md + Add CONTRIBUTING.md #77

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

Samsonroyal
Copy link

This pull request addresses issues #36, issue #54, and #49

  1. I added content to the README; with a Getting Started section to guide people who want to setup the project locally.
  2. Created The Contributor's Guideline named it CONTRIBUTING.md
  3. Cleared a warning from tailwind

Copy link

vercel bot commented Jun 9, 2024

@Samsonroyal is attempting to deploy a commit to the rhyssullivan's projects Team on Vercel.

A member of the Team first needs to authorize it.

@Samsonroyal
Copy link
Author

This pull request addresses issues #36, issue #54, and #49

1. I added content to the README; with a Getting Started section to guide people who want to setup the project locally.

2. Created The Contributor's Guideline named it CONTRIBUTING.md

3. Cleared a warning from tailwind

@RhysSullivan please do take a look and suggest any changes I need to make before PR is merge-worthy.

@amitjimiwal
Copy link

I think you missed adding setting up env and database.

@Samsonroyal
Copy link
Author

I think you missed adding setting up env and database.

Hello @amitjimiwal is this in the README.md or the CONTRIBUTING.md?

Kindly share an overview of what i should add; thanks

@amitjimiwal
Copy link

I think you missed adding setting up env and database.

Hello @amitjimiwal is this in the README.md or the CONTRIBUTING.md?

Kindly share an overview of what i should add; thanks

I was suggesting that in README development setup , it would be better if you also add the database setup part using docker-compose.yml file present in root and env variables setup. :)

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.

2 participants