Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sameerkash committed Dec 21, 2020
1 parent e7e65e8 commit d6da068
Showing 1 changed file with 63 additions and 27 deletions.
90 changes: 63 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
- [About the Project](#about-the-project)
- [Problem Statement](#Problem-Statement)
- [Features](#features)
- [Getting Started](#getting-started)
- [Database Schema](#Database-Schema)
- [Team](#team)

<!-- ABOUT THE PROJECT -->

Expand Down Expand Up @@ -41,31 +41,6 @@ PAW aims to solve:
- Online store for food & other grooming products
- Forum to discuss about your pets needs- category tags.

<!-- GETTING STARTED -->

## Getting Started

**Task List**

| sl no. | Task | Assignee | Progress |
| ------ | --------------------------------------- | -------- | -------- |
| 1 | Set up firebase | Akhil | Yes |
| 2 | Database Design | Sameer | Yes |
| 3 | UI Design | Vanshika | Yes |
| 4 | DashBoard | Akanksha | Yes |
| 5 | find a Mate | Akhil | Yes |
| 6 | Adopt don't shop | Vamsi | Yes |
| 7 | Discussions | Vamsi | Yes |
| 8 | Store | Akanksha | Yes |
| 9 | Lost and found | Akanksha | Yes |
| 10 | Authentication with firebase | Sameer | Yes |
| 11 | Vet and Consultation | Akhil | Yes |
| 12 | For Hire | Akhil | Yes |
| 13 | Train your pets, Health tips and tricks | Akanksha | Yes |
| 14 | Auth View | Sameer | Yes |
| 15 | Drawer, Profile View | Sameer | Yes |
| 16 | My Pets | Sameer | Yes |

<!-- DATABASE SCHEMA -->

## Database Schema
Expand Down Expand Up @@ -98,6 +73,38 @@ PAW aims to solve:

```
lib
β”‚ β”œβ”€β”€ models
β”‚ β”‚ β”œβ”€β”€ common
β”‚ β”‚ β”œβ”€β”€ forum
β”‚ β”‚ β”œβ”€β”€ pet
β”‚ β”‚ β”œβ”€β”€ store
β”‚ β”‚ └── user
β”‚ β”œβ”€β”€ providers
β”‚ β”œβ”€β”€ router
β”‚ β”œβ”€β”€ services
β”‚ β”œβ”€β”€ ui
β”‚ β”‚ β”œβ”€β”€ adoption
β”‚ β”‚ β”œβ”€β”€ auth
β”‚ β”‚ β”œβ”€β”€ dashboard
β”‚ β”‚ β”œβ”€β”€ drawer
β”‚ β”‚ β”œβ”€β”€ forum
β”‚ β”‚ β”œβ”€β”€ home
β”‚ β”‚ β”œβ”€β”€ lost
β”‚ β”‚ β”œβ”€β”€ mate
β”‚ β”‚ β”œβ”€β”€ messaging
β”‚ β”‚ β”œβ”€β”€ pets
β”‚ β”‚ β”œβ”€β”€ profile
β”‚ β”‚ β”œβ”€β”€ settings
β”‚ β”‚ β”œβ”€β”€ store
β”‚ β”‚ └── vet
β”‚ β”œβ”€β”€ utils
β”‚ └── widgets
└── test
2747 directories
sameerkashyap@Sameers-MacBook-Pro petme % cd lib
sameerkashyap@Sameers-MacBook-Pro lib % tree -d
.
β”œβ”€β”€ models
β”‚ β”œβ”€β”€ common
β”‚ β”œβ”€β”€ forum
Expand All @@ -112,14 +119,43 @@ lib
β”‚ β”œβ”€β”€ auth
β”‚ β”œβ”€β”€ dashboard
β”‚ β”œβ”€β”€ drawer
β”‚ β”œβ”€β”€ forum
β”‚ β”œβ”€β”€ home
β”‚ β”œβ”€β”€ lost
β”‚ β”œβ”€β”€ mate
β”‚ β”œβ”€β”€ messaging
β”‚ β”œβ”€β”€ pets
β”‚ └── profile
β”‚ β”œβ”€β”€ profile
β”‚ β”œβ”€β”€ settings
β”‚ β”œβ”€β”€ store
β”‚ └── vet
β”œβ”€β”€ utils
└── widgets
```

<!-- GETTING STARTED -->

**Task List**

| sl no. | Task | Assignee | Progress |
| ------ | --------------------------------------- | -------- | -------- |
| 1 | Set up firebase | Akhil | Yes |
| 2 | Database Design | Sameer | Yes |
| 3 | UI Design | Vanshika | Yes |
| 4 | DashBoard | Akanksha | Yes |
| 5 | find a Mate | Akhil | Yes |
| 6 | Adopt don't shop | Vamsi | Yes |
| 7 | Discussions | Vamsi | Yes |
| 8 | Store | Akanksha | Yes |
| 9 | Lost and found | Akanksha | Yes |
| 10 | Authentication with firebase | Sameer | Yes |
| 11 | Vet and Consultation | Akhil | Yes |
| 12 | For Hire | Akhil | Yes |
| 13 | Train your pets, Health tips and tricks | Akanksha | Yes |
| 14 | Auth View | Sameer | Yes |
| 15 | Drawer, Profile View | Sameer | Yes |
| 16 | My Pets | Sameer | Yes |

## Team:

| S.No. | Team Member Name | GitHub Username |
Expand Down

0 comments on commit d6da068

Please sign in to comment.