rootCircle / codemark-cli

CLI app for Codemark for HOF v4.0
https://devfolio.co/projects/codemark-251c
Apache License 2.0
6 stars 5 forks source link

[Resolve]: Create docs for setting up Firebase for Contributor #4 #8

Closed Petsamuel closed 1 year ago

Petsamuel commented 1 year ago

resolve #4

rootCircle commented 1 year ago

I believe there was come confusion in understanding in the directory structure, so sending the tree format of my dir, might be helpful!

❯ tree                    
.
├── codemark
│   ├── account.py
│   ├── check.py
│   ├── doctor.py
│   ├── firebase
│   │   ├── database.py
│   │   └── res
│   │       └── service-account-file.json
│   ├── get.py
│   ├── initialise.py
│   ├── __int__.py
│   ├── list.py
│   ├── logout.py
│   ├── result.py
│   ├── review.py
│   ├── scripts
│   │   ├── cm_cli.py
│   │   ├── __init__.py
│   ├── secrets.py
│   ├── submit.py
│   └── utils.py
├── LICENSE
├── logo.png
├── README.md
├── Schemas
│   ├── codemark-6f33a-default-rtdb-export.json
│   ├── dummy data.json
│   ├── Schema.old.txt
│   └── Schema.txt
├── Screenshots
│   ├── 1.png
│   ├── 2.png
│   └── 3.png
└── setup.py
rootCircle commented 1 year ago

Need not to mention, apart from Firebase Realtime Database, this project also requires

So, kindly include those instruction in the the doc file.

rootCircle commented 1 year ago

Do ping me! If you need any help regarding those!

Petsamuel commented 1 year ago

@rootCircle kindly review...

rootCircle commented 1 year ago

@Petsamuel Great work! I have put an another iteration of review, kindly please check them out!

rootCircle commented 1 year ago

Hey @Petsamuel ! Here is the final (presumably) iterations of reviews.

After making the changes, please move the file to docs/ directory with name FIREBASE_SETUP.md

Petsamuel commented 1 year ago

@rootCircle I'm not quite sure about your review requests! but I made changes, kindly review.

Petsamuel commented 1 year ago

@rootCircle

rootCircle commented 1 year ago

LGTM :+1: Merged! :tada: Thanks for your contribution :smile_cat:

Petsamuel commented 1 year ago

Thanks for your guidance on this project, I'm looking forward to working with you again in the future..🎊