## **Rawdaty** !

## **Main Problem** :no_entry_sign:
Parents find it’s hard to get a good kindergarten for their children that appropriates with their location and financial capabilities for the parents, and it should have good reviews and rates.

## **Problem Solution** :bulb:
Create an application that allows parents to find the appropriate kindergarten according to their location, people reviews, and fees, and they can add their comments and reviews about any kindergarten. Also, the application allows any kindergarten owner to add their kindergarten.

## **User Stories** :books:
### **As a user**
- I can see a list of top-rated kindergartens.
- I can search from any page.
- I can Select the kindergarten's location before Search using the kindergarten's name.
- I can Filter the search result by tuition fees, location, and reviews.
- I can see inside each kindergarten's card (name, location, photo, rate, NO.people ).
- I can see a kindergarten's profile when I click on the cards.
- I can see (the main photo, name, about, shifts' time, contact, more pictures, location (map), tuition fee, rate, and comments for review) In the profile.
- I can add a review about the kindergarten.

### **As a kindergarden Owner**
- I can send a request for adding a new kindergarten.

### **As an Admin**
- I can accept or reject the new requests for kindergartens.
- I can add new kindergarten.
- I can see a list of kindergartens.
- I can search through the list of kindergartens and filter them by price and location.
- I can edit and delete kindergartens.
- I can disable kindergartens.
- I can delete the comments.

## **User Journey** :pencil2:
- As a user, I can search for kindergartens by entering the name, with the ability to specify the location and the price to get the desired search results that I need. Also, I can see the top-rated kindergartens. I can open the profile of any kindergarten to see all information about it. I can add my rate and review to any kindergarten to help other parents.

- As a kindergarten owner, I can send a request to add my kindergarten information to the website.

- As an admin, I can log in to the dashboard, I can see a list of all the kindergartens, see the details for each kindergarten, and I have the ability to delete the kindergarten or edit its data or delete any comments. Also, I can make any kindergarten disabled or enabled, and search for any kindergarten and filter the search results depending on location, price, review, and its status (disabled, enabled). Also, I can add a new kindergarten and, in the notifications section, I can see the requests from kindergarten owners to add new kindergarten, and I can accept or ignore these requests. And I can search in the notifications by user name or kindergarten name. Finally, I can log out from the dashboard.

## **Prototype**
[View Prototype](https://www.figma.com/proto/8LEYqUAyNG78PZyy2NMKJ1/Kindergarden-Database?node-id=39%3A124&scaling=min-zoom)

## **Technologies**
BackEnd: **Node JS** & **Express JS**
FrontEnd: **React JS**
Database:
Styling: **CSS**
Libraries: **AntDesign**

## **How to Launch App Locally**
*
*
*

### Database Setup

### Environment Variables

### Start the App

## **Team Lead**
* Muhammad

## **Team Members**
* Alaa
* Alaa
* Israa
* Osama

## **Resources**
* [Node Js](https://nodejs.org/en/)

## **Routes**
### Front-end:
- [ ] Home page: `/`
- [ ] About page: `/aboutUs`
- [ ] Search Results page: `/search?q&location&minPrice&maxPrice`
- [ ] Kindergarten profile page `/kindergarten/:id`
- [ ] User login page: `/login`
- [ ] User SignUp page: `/signup`
- [ ] Admin login page: `/admin/login`
- [ ] Admin dashboard page (list of kindergartens) `/admin/dashboard`
- [ ] Admin add new kindergarten `/admin/dashboard/addKindergarten`
- [ ] Admin notifications list `/admin/dashboard/notifications`

### Back-end:(/api/v1)

- [ - ] GET `/kindergarten`
* get all kindergartens data
- [ ] POST `/kindergarten`
* add new kindergarten
- [ ] GET `/kindergarten/:id`
* get kindergaten profile details
- [ - ] PUT `/kindergarten/:id`
* update or edit kindergarten profile details
- [ ] GET `/kindergarten/:id/comments`
* get all comments of this kindergarten
- [ ] POST `/kindergarten/:id/comments`
* add new comment to this kindergarten
- [ - ] DELETE `/kindergarten/:id`
* delete this kindergarten
- [ - ] GET `/users`
* get all users
- [ - ] GET `/users/:userId`
* get data for a specific user by id
- [ - ] PUT `/users/:userId`
* update user data
- [ ] POST `/signup`
* add a new user
- [ ] POST `/login`
* login for the user
- [ ] GET `/logout`
* logout for the user
- [ - ] DELETE `/comments/:commentId`
* delete a specific comment by comment id
- [ ] GET `/search?q&location&minPrice&maxPrice&rating`
* return a list of kindergartens according to name,location,price and rating

### sd
// admin
- [ ] GET `/admin/kindergartenList?q=&location=&minPrice=&maxPrice=&ratingForm=&isEnable=` // no value is requaird
- [ ] post `/admin/kindergartenAdd` // the admin will be the owner
- [ ] GET `/admin/notifications?q=&searchType=` // no value is requaird
- [ ] DELETE `/comments/:commentId`
- [ ] DELETE `/kindergarten/:id`
- [ ] GET `/users`
- [ ] GET `/users/:userId`
- [ ] PUT `/users/:userId`

// anyone
- [ ] POST `/login`
- [ ] GET `/logout`
- [ ] POST `/signup`

- [ ] GET `/kindergarten/:id`
// if kindergarten isEnable=true and requestStatus=accepted
- [ ] GET `/kindergarten/:id/comments`
// if kindergarten isEnable=true and requestStatus=accepted
- [ ] POST `/kindergarten/:id/comments`
// if kindergarten isEnable=true and requestStatus=accepted
- [ ] GET `/search?q=&location=&minPrice=&maxPrice=&ratingForm=&maxResults`
// if kindergarten isEnable=true and requestStatus=accepted
// for home page we can use (/search?ratingForm=Highest&maxResults=9)

// login user
- [ ] POST `/kindergarten` // add kindergarten
- [ ] PUT `/kindergarten/:id` // if he is this kindergarten owner

### sd