search

RhysSullivan / shiptalkers

https://shiptalkers.dev
699 stars 35 forks source link

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

Open Samsonroyal opened 3 months ago

Samsonroyal commented 3 months ago

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
vercel[bot] commented 3 months ago

@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 commented 3 months ago

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 commented 3 months ago

I think you missed adding setting up env and database.

Samsonroyal commented 3 months ago

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 commented 3 months ago

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. :)