Issues Guide

[Asmaathabet]

write your issue Clearly and neatly

• Setup & configurations issues
• Front End Routes & Back End Routes issues
• Front End issues
• Back End issues
• Component Map
• Component issues
• Components Notes

[Asmaathabet]

Setup & configurations issues ✔️

• you should write the steps of setup something in details and neatly.
• you should add any important configuration or instructions related to the issue.

[Asmaathabet]

Frontend [Applicants] Routes ✔️

Route	Description	Issue Number
/	Home page, displaying Hamburger Icons contain login sign up	#1
/signin

[Asmaathabet]

Backend [Admin] Routes ✔️

Route	GET	POST	Delete	Issue Number
/
/login		login to the website by entering email and password		#2

[Asmaathabet]

Front End Issues ✔️

• Route
  / : Home
  protected : true

• UI
  [take screenshot and add it here] 😄

[Asmaathabet]

Back End Issues ✔️

Home Route

display home page

Route : /

Method : GET

---

Main Things :

• Database
• Response
• Test

---

Database :

Use database query to fetch data that related to specified applications by using application id that provided in the endpoint.

---

Response :

Response may be success or error :

• Error :

    {
    error: "bad request",
    "Status-Code": 400
    }

• Success

    {
    data: [] , 
    "Status-Code": 200    
    }

---

Test :

• Route :
  Test route by testing all the expected cases for correct retrieve for data from application table.

• Query :
  Test select database query to make sure that everything is ok .

[Asmaathabet]

• Labels --> React , React-component, common- component, Front , Front End, Front End Routes

Components Map ✔️

No.	component Name	common	Applicant	admin	pages Names	Issue Number	Assign to
1-	Button	yes			- Applicant-Home , admin- Dashboard	#	@hassanannajjar

[Asmaathabet]

• Labels --> React , React-component, common-component [if it was common] ,applicant [if it was for applicant only], admin [if it was for admin only ] , Front End, to do

Issues Form :

Common Component | Button ✔️

or

Applicant Component | Button ✔️

or

Admin Component | Button ✔️

---

inside issue ex: Common Component - Button:

Our App will has many Buttons in many pages so, we have to use common component called Button and used it more than once.

• Common Component Folder Name
  Button

• It will be used in Pages
  Home , Dashboard

• Material UI Link
  Button

• UI Image From Design
  <<< image >>> 📷

[Asmaathabet]

Note :

when you work in component Don't Forget :
1- use Prop Types in every component .
https://reactjs.org/docs/typechecking-with-proptypes.html
https://www.npmjs.com/package/prop-types

2- unified the style by one measurable unit which is rem = 16px.
3- creating the component as it needs to be [function , class ] .
4- component name's First Letter should be capital letter