#15

• Route Name:

• route: /favorite-list/:houseId
• method: GET

Acceptance Criteria

• Response

• Success

res.body = {
  statusCode: 201,
  message: 'House added to the favorite list',
}

• Failed

res.body = {
  statusCode: 500,
  messgae: 'Something went wrong!'
}

• Testing

#8
I need to compare between two houses
As a user I can:

• choose two houses from my favorite list to compare between them.
• See the difference between the houses according to the number of the rooms, location, cost and type.

#5

Eslint

• process of checking your code for errors of any kind.
  install eslint

npm i -D eslint

initialize in the code

./node_modules/bin/eslint --init

Travis

• automatically building and testing code changes in the development process
  configuration
• Go to Travis-ci.com and Sign up with GitHub.
• Accept the Authorization of Travis CI. You’ll be redirected to GitHub. For any doubts on the Travis CI GitHub Authorized OAuth App access rights message
• Click on your profile picture in the top right of your Travis Dashboard, click Settings and then the green Activate button, and select the repositories you want to use with Travis CI.
  **initialize in the code **
• add .travis.yml file in your file structure
  -and then add below code to build travis in your code

language:node_js
node_js:lts/*

#8
I need a control panel to manage my houses.

As a user I can:

• Preview my houses
• add a new house.
• delete the house from the house list.
• edit my house.
• filter and sort houses.

• Description
  footer component

• Structure

make footer component contain :

• copy right

• UI
  

#5

• Build database schema.
• schema should have tables with fake data

• Description
  Header component

• Structure

make footer component contain :

• logo
• navBar

• UI
  

#11

• Route

• /profile-img

• methods : Delete

Description
-delete user profile image

Acceptance Criteria

• - validation

• - request body

• Response

• Success

{ statusCode:200 ,message: " Deleted successfully "  }

• Failed

{statusCode: 400, message:"bad Request "}

• Testing

#5

• connect to the pool in database
• Read the SQL file
• build database

#17

• Route Name:
  Route: /user/houses
  Method: GET

Acceptance Criteria

• Response

• Success

{
  statusCode: 200,
  houses: {}
}

• Failed

{
  statusCode: 500,
  message: 'some error happend'
}

• Testing

#8
I need to compare between two houses
As a user I can:

• choose two houses from my favorite list to compare between them.
• See the difference between the houses according to the number of rooms, location, cost, and type.
• delete any favorite house from my favorite list.

#8
I need to create my own profile
ِAs a user, I can:

• View my profile info
• Update my information
• Delete my account
• Add an avatar
• Update my avatar
• Delete my avatar
• Update my houses info

fix client error on jest version

#8
I want to search by different locations, prices and the number of room in the house

As a user, I can:

• Search by location to see all houses in a specific location
• Search through houses with a specific numbers rooms
• Search through houses with a specific price
• See the final results after applying the filters.
• Add house to my favorite list

#15

• Route Name:

• Route: /favorite-list/:houseId
• Method: DELETE

Acceptance Criteria

• Response

• Success

{
  statusCode: 200,
  message: 'Favorite house deleted'
}

• Failed

{
  statusCode: 500,
  messgae: 'Something went wrong!'
}

• Testing

#15

• Route Name:

• Route: /favorite-list
• Method: GET

Acceptance Criteria

• Response

• Success

{
  statusCode: 200,
  favHouse: {
    title: '...',
    description: '...',
    price: 100,
    rooms: 1,
    baths: 1,
    ...
  }
}

• Failed

{
  statusCode: 500,
  messgae: 'Something went wrong!'
}

• Testing

#17

• Route Name:
  Route: /houses/:houseId
  Method: DELETE

Acceptance Criteria

• Response

• Success

{
  statusCode: 200,
  success: true,
  message: 'House deleted'
}

• Failed

{
  statusCode: 500,
  success: false,
  message: 'Something went wrong!'
}

• Testing

1. file structure
2. ESlint and Travis CI config
3. set up Heroku
4. Readme

#17

• Route Name:
  Route: /houses/:houseId
  Method: PATCH

Acceptance Criteria

• Validation schema

• Request

req.body = {
  houseId: '',
  title: '',
  description: '',
  rooms: 2,
  baths: 2,
  price: 100,
  location: '',
  category: '',
  area: '',
  image: '',
}

• Response

• Success

{
  statusCode: 200,
  success: true,
  message: 'House updated'
}

• Failed

{
  statusCode: 400,
  success: false,
  message: 'Bad request'
}

• Testing

#8
sign up

As a user, I can:

• enter a user name, email, location, phone, and password to be able to sign up for the app

#5

update config

• fix travis.yml file
• update eslint client config

#14

Route Description

• login route
• full-route /login
• method : post

Acceptance Criteria

Validation schema

• using yup: validation library that allows you to build schemas to validate JavaScript objects.

{      
email : sting().email().required(),
password:string().min(6).alphanum().required(),
}

Request body

 req.body =  {
      email: adham@adham.adham,
      password: adham123
  }

Response

Success

{ statusCode: 200  ,data: {
"id": "348680c7-d46b-4adc-9be0-89a1d1a38566",
 "token": "jNK_DGszYOMEpPOFoRGjuyJ5KX9kaJQKCl3cujlWi",
"message": "Login Successfull",
"success": true
}

Failed

{statusCode: '400' , message:"user is not authorized, either username and password don't match, or user does not exist"}

Testing

• true

• Description
  custom button component

• Structure

• UI
  
  
  
  
  

#5

• Deploy the app on Heroku
• edit config vars

Reviewing code

• Every PR must be approved by all the team in order to be merged
• Don't resolve a comment on your PR but only comment back (reply), and let the comment writer resolve it

Working on a task

1. Branch naming: branch names shall follow this style issueNumber-issue-description (e.g. 102-login-page)

2. Committing changes:

   • any changes that are not related to the task (issue) or are not mentioned in it will not be accepted (if there is a bug that is making your task fail, open an issue for it and start working on fixing it)
   • commits must always be descriptive and with appropriate length (neither too long nor too short)
   • every and each commit must relate to the issue at the end

3. Use of labels and projects

   • once started working on a task
     • label the issue in progress and move it to the in progress column in its project
     • label the PR awaiting review if you need it to be reviewed
     • label the PR in progress if you still working on it
     • PRs must be labeled with changes requested once a change is requested
   • once finished working on a task and got approved
     • label the PR done before merging it
     • label the issue done and move it to the done column in its project
     • close the issue

4. closed issues and PRs

   • once a PR or an issue is closed it shall not be reopened
   • if there exists a bug related to a specific issue that was closed, another issue is to be opened and labeled bug
   • if there exists some critical bug that is causing the project to crash an issue with the labels bug, urgent, and priority is to be opened

#[relates1] #[relates1]
[Unit name]

Acceptance Criteria

• crit1
• crit2
• ..
• ..

crit1

[Full Description ]

crit2

[Full Description]

fix deploy error and change files extinctions

• update user information

• full-route /users
• method : PATCH

Acceptance Criteria

• Validation schema

• Request body

 req.body =  {
      username:" ",
      email: " ",
      mobile:  
  }

• Response
• Success

{ statusCode: 200,message:"user updated successfully"}}

• Failed

{statusCode:500 , message:"some error happened  "}

• Testing

#16

• Route Name

• full-route /houses?location=gaza
• method : Get

Acceptance Criteria

• Response
• Success

{ statusCode: 200 ,data : {
[
{...},
]
 }}

• Failed

{statusCode: 500 , message:"some error happend "}

• Testing

• false

As a user, I can see all available houses that able to rent, search to find houses and I can add any liked house to my favorite list and compare the differences between two houses from my favorite list, inside my profile I have my information and control panel for my own houses available to rent.

#2

Back-end Routes Template

• Route Name

• full-route /
• method : ...

Acceptance Criteria

• Validation schema

• Request body

 req.body =  {
      
  }

• Response
• Success

{ statusCode:  ,data : { }}

• Failed

{statusCode: , message:" "}

• Testing

#9

• Route

• / signup
• method : post

Description

• Register page

Acceptance Criteria

• Validation schema

• using Yup: validation library that allows you to build schemas to validate JavaScript objects.

{      
username : string().required(),
email : sting().email().required(),
password:string().min(6).alphanum().required(),
 confirmPassword: ref('password'),
phone : number().integer().required()
}

• Request body

{
username: guest
email : guest123@gmail.com
password:password@guest123
confirmPassword:password@guest123
phone : 0598000000
}

• Response

• Success

{ statusCode:201 , message : " sign up successfully " }}

• failed
• user exists

{ statusCode:409 , message : " already sign up try to signin  " }}

• validation error

{ statusCode:400 , message : " Bad request check vaildation   " }}

• Testing

• Route

• /logout user

• method: GET

Description

• logout user

Acceptance Criteria

• validation

• Response

• Success

{ statusCode:200 ,message: "Log out successfully  "  }

• Failed

{statusCode: 400, message:"bad Request "}

• Testing

• add live demo section to read me file
• update ...

• Description
  card component to present house object

• Structure

make card component contain :

• house title
• location
• description
• price
• bed rooms number and bath rooms
• more details button
• favorite button

• UI

• Description
  LinkItem component to take you to another page.

• Structure

Make LinkItem component contain :

• Link label
• href

• UI

#8
I can see all available houses to rent
As a user, I can

• See the top-rated houses
• See the newest houses
• search for any available house.

#17

• Route Name:
  Route: /houses
  Method: POST

Acceptance Criteria

• Validation schema

• Request

req.body = {
  title: '',
  description: '',
  rooms: 2,
  baths: 2,
  price: 100,
  location: '',
  category: '',
  area: '',
  image: '',
}

• Response

• Success

{
  statusCode: 201,
  success: true,
  message: 'House added'
}

• Failed

{
  statusCode: 400,
  success: false,
  message: 'Bad request'
}

• Testing

File Structure #5

• client/

  • public/
  • src/
    • App/
    • components/
      • Card/
        • index.js
        • style.css
      • Header/
      • Footer/
    • Pages/
      • AboutUs/
      • ContactUs/
      • DetailsHouse/
      • FavoriteList/
      • Houses/
      • Landing/
      • Layout/
      • Login/
      • NotFound/
      • Profile/
        • index.js
        • style.css
        • AddHouse.js
      • Register/
    • Utils/
      • images
        • logo.svg
      • routes.constant.js
    • index.js
    • index.css

• server/

  • controller/
    • routes/
      • error
        • 404.js
        • 500.js
        • index.js
      • routes
        • house
          • index.js
        • user
          • index.js
  • database/

    • config/

      • build.js
      • build.sql
      • connection.js
      • fakeData.sql

    • queries/

      • house
        • index.js
      • user
        • index.js
  • middlewares/
    • auth/
      • index.js
      • checkToken.js
    • validation
      • index.js
  • router
    • index.js
    • house.js
    • user.js
  • app.js
  • index.js
  • .env

• test/

  • queries
    • index.js
    • user.test.js
  • routes
    • users.test.js

• .gitignore

• package-lock.json

• package.json

#16

• Route

• /houses

• method: GET

Description

• all houses data

Acceptance Criteria

• validation

__

• Response

• Success

{ statusCode:200 ,data:[
{
  title: '',
  description: '',
  rooms: 2,
  baths: 2,
  price: 100,
  location: '',
  category: '',
  area: '',
  image: '',
},
  {
  title: '',
  description: '',
  rooms: 2,
  baths: 2,
  price: 100,
  location: '',
  category: '',
  area: '',
  image: '',
}
]  
}

• Failed

{statusCode: 400, message:"bad Request "}

• Testing

#8
I can see specific information about any house

as a user, I can

• see more details about the house like full description, owner contact info.
• browse related houses.
• Add house to my favorite list

#8
I can log into the app.
As a user, I can enter my username and password to be able to log into the app.

#5
create a server using Express.js framework

npm install express 
 

#11

• Route

• /profile-img

• methods : patch

Description

• edit user profile image

Acceptance Criteria

• validation

• Request body

 req.body =  {
      avatar: 'https://user-images.githubusercontent.com/25705602/106442463-f7740000-6483-11eb-8d3f-245c188c6c21.png'
  }

• Response

• Success

{ statusCode:200 ,message: " Updated successfully "  }

• Failed

{statusCode: 400, message:"bad Request "}

• Testing

#11

• Route Name

• /users

• method: DELETE

Acceptance Criteria

• Validation schema

• Request body

req.body =  {
 }

• Response
• Success

{ statusCode:200, message :"your account deleted successfully"  }

• Failed

{statusCode: 500, message:"some error happend "}

• Testing

write readme file
#5