relates #5

Route: GET api/v1/users

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM users ;

Response

• Success

{ 
    statusCode:200 ,
     data:  
     [{ 
        user_id,
        user_name,
        email,
        password,
        is_admin,
        create_at
     }]
}

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === "array"
• data.length !== 0

relates #5

Route: GET api/v1/kindergarten/:id/comments

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM comments WHERE kindergarten_id = id;

Response

• Success

{ StatusCode: 200,
  data: [{
          comment_id,
          kindergarten_id,
          user_name,
          comment,
          rating,
          create_at
      }]

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === "array"
• data.length !== 0

Our readme file should contain:-

• Main Problem 🚫
• Problem Solution 💡
• User Stories 📚
• User Journey ✏️
• Prototype 🎨
• Technologies 💻
• How to Launch App Locally 📣
  • Database Setup
  • Environment Variables
  • Start the App
• Team Lead 😎
• Team Members 😃
• Resources 🔍

User Routes

Admin Routes

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

Acceptance Criteria

• crit1
• crit2
• ..
• ..

crit1

[Full Description ]

crit2

[Full Description]

Acceptance Criteria

• Props
• Snapshot

Props

• title
• rating
• revieweresNo
• location
• price
• cover
• kindergartenId

Components

• < Rating />

Snapshot

Component

Acceptance Criteria

• Props
• Component
• Snapshot

Props

• userName
• kindergartenName
• id

Component

<UserImage/>

Snapshot

relates #5

Route: POST api/v1/login

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM users WHERE email = email AND password = password

Validation

{
 email: yup.string().email().required(),
 password: yup.string().min(8).required(),
}

Response

• Success

{statusCode:200, message:"login is succeed"}

• Failed

{statusCode:400, message:"email or password is wrong"}

Testing

to be a successful test

• status === 200
• typeof(data) === "object"
• data.length !== 0

Acceptance Criteria

• Snapshot

Snapshot

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. Commiting 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 which 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

Acceptance Criteria

• Props
• Snapshot

Props

• image

Snapshot

relates #5

Route: GET api/v1/kindergarten

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM kindergarten WHERE is_enable = ture AND request_status = 'Accepted';

Response

• Success

{ StatusCode: 200,
  data: [{
          id,
          kindergarten_name,
          cover_image,
          description,
          phone_number,
          latitude,
          longitude,
          min_price,
          max_price,
          periods,
          images_gallery,
          create_at
        }]
}

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === "array"
• data.length !== 0

/

Acceptance Criteria

• State
• Props
• Components
• Snapshot

State

const [isLoaded,setIsLoaded] = useState(true);
const [data,setData] = useState([]);
const [kindergartenName,setKindergartenName] = useState("");
const [location,setLocation] = useState("");
const [minPrice,setMinPrice] = useState(0);
const [maxPrice,setMaxPrice] = useState(0);

Props

xxxx

Component

• < Navbar />
• < Search />
• < CardContainer />
• < Footer />

Snapshot

relates #5

Route: POST api/v1/signup

Acceptance Criteria

• Validation
• DB query
• Response
• Testing

Validation

{
 username: yup.string().alphanum().min(5).required(),
 email: yup.string().email().required(),
 password: yup.string().min(8).required(),
 confirmPassword: yup.string().oneOf([yup.ref('password'), null], 'Passwords must match')
}

DB query

UPDATE  users 
SET user_name = user_name,
        email = email,
        password = password
WHERE  user_id=id;

Response

• Success

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

• Failed

{
statusCode:401, 
message:"update failed"
}

Testing

to be a successful test

• status === 200
• data.length !== 0

relates #5

Route: POST api/v1/kindergarten

Acceptance Criteria

• DB query
• Response
• Testing
• Validation

DB query

INSERT INTO kindergarten (kindergarten_name,cover_image,description,phone_number,latitude,longitude,min_price,max_price,periods,images_gallery)
    VALUES (kindergarten_name,cover_image,description,phone_number,latitude,longitude,min_price,max_price,periods,images_gallery)

Response

• Success

{ 
    StatusCode: 200,
    message: 'Kindergarten has been added successfully',
}

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === 'object'
• message === 'Kindergarten has been added successfully'

Validation

{
  kindergartenName: yup.string().required(),
  coverImage: yup.string().url().required(),
  description: yup.string().required(),
  phoneNumber: yup.number().required(),
  periods: yup.string(),
  latitude: yup.number(),
  longitude: yup.number(),
  minPrice: yup.number(),
  maxPrice: yup.number(),
  imagesGallery: yup.string(),
}

Acceptance Criteria

• Props
• Component
• Snapshot

Props

• data

Component

• < Comment />

Snapshot

Issues Template

relates #5

Route: DELETE api/v1/kindergarten/:id

Acceptance Criteria

• DB query
• Response
• Testing

DB query

DELETE * FROM kindergarten WHERE kindergarten_id=id  CASCADE;

Response

• Success

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

• Failed

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

Testing

to be a successful test

• status === 200

relates #5

Route: PUT api/v1/kindergarten/:id

Acceptance Criteria

• DB query
• Response
• Testing

DB query

UPDATE kindergarten SET phone_number = 0123456789 WHERE  id=id;

Response

• Success

{ 
 StatusCode: 200,
 message : 'Update kidergarten profile data Successfully'
}

• Failed

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

Testing

to be a successful test

• status === 200
• message === 'Update kidergarten profile data Successfully'

Issues Template

relates #5

Route: GET api/v1/search?q=&location=&minPrice=&maxPrice=&rating=&maxResults

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT 
kindergarten.kindergarten_name,kindergarten.cover_image,kindergarten.description, 
kindergarten.phone_number,kindergarten.min_price,kindergarten.max_price,
kindergarten.periods,kindergarten.images_gallery,location.location_name,
comments.comment ,comments.rating
FROM 
kindergarten ,location,comments
WHERE
kindergarten_name = q OR min_price = min_price OR max_price=max_price OR location 
IN
(SELECT location_name FROM location WHERE kindergarten.location_id =location.location_id ) OR rating
IN
(SELECT rating FROM comments WHERE kindergarten.kindergarten_id = comments.kindergarten_id);

Response

• Success

{ StatusCode: 200,
  data: [{
          id,
          kindergarten_name,
          cover_image,
          description,
          phone_number,
          latitude,ND
          longitude,
          min_price,
          max_price,
          periods,
          images_gallery,
          create_at
        }]
}

ND

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === "array"
• data.length !== 0

Frontend Routes

Admin Frontend Routes

Input Component

Acceptance Criteria

• Props
• Snapshot

Props

• labelText
• placeholder
• type [text,textarea,date,rangeSlider]
• value

Snapshot

relates #5

Route: GET api/v1/kindergarten/:id

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM kindergarten WHERE kindergarten_id = id;

Response

• Success

{ StatusCode: 200,
  data: {
          id,
          kindergarten_name,
          cover_image,
          description,
          phone_number,
          latitude,
          longitude,
          min_price,
          max_price,
          periods,
          images_gallery,
          create_at
        }
}

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === "object"
• data.length !== 0

Acceptance Criteria

• Props
• Component
• Snapshots

Props

• userName
• userImage
• userKindergardenId

Component

• < MainBotton />
• < NavTap />

Snapshots

/login

Acceptance Criteria

• State
• Props
• Components
• Snapshot

State

const [userName,setUserName] = useState("");
const [password,setPassword] = useState("");

Props

xxxx

Component

• < Login />

Snapshot

Acceptance Criteria

• Component
• Snapshot

Component

• <SideButton />

Snapshot

Acceptance Criteria

• Props
• Snapshots

Props

• Icon
• text
• isActive (default false)

Snapshots

Acceptance Criteria

• Props
• Component
• Snapshots

Props

• title
• data

Component

• < Card />

Snapshots

relates #3

.travis.yml

language: node_js

node_js:
  - lts/* 

services:
  - postgresql

before_script:
  - psql -c "create database db_test_name" -U postgres
  - psql -c "create user username with password '12';" -U postgres
env: 
  global:
  - PGPORT=5432
test:
  adapter: postgresql
  database: db_test_name

Acceptance Criteria

• Props
• Snapshot

Props

• minValue
• maxValue

Snapshot

[Project Setup]

Acceptance Criteria

• File Structure
• Server Setup
• Client (React) Setup
• ESLINT config

File Strucutre #3

• Client
• Server
• Testing
  #3

Server Setup

• Install modules :
  • express
  • jsonwebtoken
  • yup
  • dotenv
  • cookie-parser
  • compression
  • pg
  • nodemon
  • supertest
  • jest
  • eslint
  • pre-commit

Setup the server and make it listen on port 5000

React Setup

Generate react app for the client using command

npx create-react-app 

• Install modules :
  • prop-types
  • react-router-dom
  • axios
  • antd

Travis CI #6

add .yml to the structure

ESLINT config #10

• ESLINT for the server

      eslint
      eslint-config-airbnb-base
      eslint-plugin-import
      eslint-config-prettier
      eslint-plugin-prettier
      eslint-plugin-flowtype
      eslint-plugin-jsx-a11y
      eslint-plugin-react
      eslint-plugin-react-hooks
      prettier

• ESLINT for the react #10

      eslint
      eslint-config-airbnb
      eslint-plugin-prettier
      save-exact prettier
      eslint-config-prettier
      prettier

File Structure

• client/

  • public/
  • src/
    • assets/
      • icons
      • images
    • components/
      • utils/
        • admin/
        • user/
        • index.js
      • pages/
        • admin/
          • index.js
        • Home/
          • index.js
      • app/
        • index.js
        • app.module.css
  • .gitignore
  • .eslintrc.json
  • package-lock.json
  • package.json

• server/

  • controllers/

    • routes/

      • index.js

    • middlewares/

      • auth/
        • index.js
      • errorHandle/
        • index.js

    • utils/

      • index.js

    • index.js

  • database/

    • config/

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

    • queries/

      • index.js
  • validation/
    • index.js
  • app.js
  • index.js
  • .env

• test/

• .travis.yml

• .gitignore

• .eslintrc.json

• package-lock.json

• package.json

relates #5

Route: GET api/v1/logout

Acceptance Criteria

• Response
• Testing

Response

• Success

{ 
    statusCode:200,
    message:'Sign out successfully',
}

• Failed

{
    statusCode:500, 
    message:"Internal Server Error",
}

Testing

to be a successful test

• status === 200

Schema Tables

Schema Info

• Kindergarten

• Location

• User

• Comment

• Heroku configurations
• Bring heroku database link
• Connect repo with heroku

Acceptance Criteria

• State
• Props
• Components
• Snapshot

State

const [query , setQuery] = useState('');
const [location , setLocation] = useState('');
const [minprice, setMinPrice] = useState(0);
const [maxprice , setMaxPrice] = useState(0);

Props

xxxx

Component

• <search/>

Snapshot

relates #5

Route: DELETE api/v1/comments/:commentId

Acceptance Criteria

• DB query
• Response
• Testing

DB query

DELETE FROM comment WHERE commentId = id;

Response

• Success

{ StatusCode: 200,
message: 'Delete comment Successfully'
}

• Failed

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

Testing

to be a successful test

• status === 200
• message === 'Delete comment Successfully'

MainButton Component

Acceptance Criteria

• Props
• Snapshot

Props

• backgroundColor
• borderColor
• fontSize
• fontColor

Snapshot

relates #5

Route: POST api/v1/kindergarten/:id/comments

Acceptance Criteria

• DB query
• Response
• Testing
• Validation

DB query

INSERT INTO comments (user_name ,comment, rating, create_at) VALUES ($1, $2, $3, $4) WHERE kindergarten_id = id;

Response

• Success

{ StatusCode: 200,
 message: 'Add comment successfully'
}

• Failed

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

Testing

to be a successful test

• status === 200
• message === "Add comment successfully"

Validation

• {comment: yup.mixed().required()}

app.js

• Install middlewares

  • app.use(express.json());
  • app.use(cookieParser());
  • app.use(compression());
  • app.use(express.urlencoded({ extended: false }));
  • app.disable('x-powered-by');

• Handling server and client errors

• Setup the server on port 5000

  • app.set('port', process.env.PORT || 5000);

index.js

• Import app.js in index.js and listen to our app

app.listen(port, () => {
  // eslint-disable-next-line no-console
  console.log(`server is running http://localhost:${port}`);
});

relates #5

Route: GET api/v1/users/:userId

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM users WHERE id = userId;

Response

• Success

{ 
    statusCode:200 ,
     data:  
     { 
        user_id,
        user_name,
        email,
        password,
        is_admin,
        create_at
     }
}

• Failed

{
    statusCode:404, 
    message:'User not found',
}

Testing

to be a successful test

• status === 200
• typeof(data) === 'object'

Search Component

Acceptance Criteria

• Components
• Snapshot

Components

• <DorpList />
• <MainInput type="rangeSlider"/>
• <MainInput type="search"/>
• <MainButton />

Snapshot

Acceptance Criteria

• Props
• Components
• Snapshot

Props

• name
• rating
• date
• commentText
• commentId
• isAdmin

Components

• < Rating />
• < UserImage />
• < MainButton />

Snapshot

relates #5

Route: GET api/v1/admin/kindergarten

Acceptance Criteria

• DB query
• Response
• Testing

DB query

SELECT * FROM kindergarten ;

Response

• Success

{ StatusCode: 200,
  data: [{
          id,
          kindergarten_name,
          cover_image,
          description,
          phone_number,
          latitude,
          longitude,
          min_price,
          max_price,
          periods,
          images_gallery,
          create_at
        }]
}

• Failed

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

Testing

to be a successful test

• status === 200
• typeof(data) === "array"
• data.length !== 0

ESLINT config

• ESLINT for server file

• You should install these modules as devDependencies

   eslint
   eslint-config-airbnb
   eslint-plugin-prettier
   save-exact prettier
   eslint-config-prettier
   prettier
  

• Eslint for React app

• And the same here

    eslint
    eslint-config-airbnb-base
    eslint-plugin-import
    eslint-config-prettier
    eslint-plugin-prettier
    eslint-plugin-flowtype
    eslint-plugin-jsx-a11y
    eslint-plugin-react
    eslint-plugin-react-hooks
    prettier
  

VS Code settings

• Create settings.json file in .vscode folder then inside the file add

  {
    "eslint.workingDirectories": ["client", "server"],
    "[javascript]": {
      "editor.codeActionsOnSave": {
        "source.fixAll": true
      },
      "editor.formatOnSave": false
    },
    "[json]": {
      "editor.defaultFormatter": "vscode.json-language-features"
    },
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true,
    "files.eol": "\n"
  }

Acceptance Criteria

• Props
• Snapshot

Props

• icon
• text
• isActive

Snapshot

Rating Component

Acceptance Criteria

• Props
• Snapshot

Props

• Rating Value

Snapshot

relates #5

Route: POST api/v1/signup

Acceptance Criteria

• Validation
• DB query
• Response
• Testing

Validation

{
 username: yup.string().alphanum().min(5).required(),
 email: yup.string().email().required(),
 password: yup.string().min(8).required(),
 confirmPassword: yup.string().oneOf([yup.ref('password'), null], 'Passwords must match')
}

DB query

INSERT INTO users(user_name,email,password) VALUES(user_name,email,password);

Response

• Success

{ 
  StatusCode: 200,
  message :"Sign up successful"
}

• Failed

{
statusCode:401, 
message:"You are already registered"
}

Testing

to be a successful test

• status === 200
• data.length !== 0

AdminNavBar Component

Acceptance Criteria

• Props
• Component
• Snapshot

Props

• userName
• UserImage
• notificationData

Component

<NotificactionContainer/>

Snapshot

NotificactionContainer Component

Acceptance Criteria

• Props
• Component
• Snapshot

Props

• notificationData

Component

<Notification/>

Snapshot

SearchInput Component

Acceptance Criteria

• Props
• Snapshot

Props

• value

Snapshot