https://github.com/sultan308/masjidi
A web app serving masjids details and providing a space to share feedback about them.
https://github.com/sultan308/masjidi
express nodejs postgresql reactjs restful-api
Last synced: 3 months ago
JSON representation
A web app serving masjids details and providing a space to share feedback about them.
- Host: GitHub
- URL: https://github.com/sultan308/masjidi
- Owner: sultan308
- Created: 2022-06-23T13:49:25.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-29T12:17:05.000Z (about 4 years ago)
- Last Synced: 2025-02-26T11:38:44.008Z (over 1 year ago)
- Topics: express, nodejs, postgresql, reactjs, restful-api
- Language: JavaScript
- Homepage:
- Size: 876 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# **Masjidi**
A web app serving masjids details and providing a space to share feedback about them.
## Installation
```bash
$ git clone git@github.com:sultan308/masjidi.git working-directory-name
$ cd working-directory-name
$ cd server
$ npm install
$ cd ../client
$ npm install
```
Then rename the ".example.env" file in the server folder to .env and enter your environment values.
## GUI Usage
### Home page
#### From the home page the user can :
* Add a new Masjid
* Click on a masjid to got to it's page
* Delete a masjid
* Go to the masjid update page by clicking update
* See all masjids with their average rating, number of reviews and locaton
### Masjid page
#### From the Masjid page the user can :
* Add a new review
* View masjid reviews
* See all the masjid details
Note : The review color changes in correspondence with the rating value.
### Update masjid page
#### From the Update masjid page the user can :
* Change the masjd name
* Change the masjid location
Note : After clicking update the user will be redirected to the home page.
---
## API Usage
### ```GET``` Requests:
---
#### ```{host}/api/v1/masjid```
##### Request body
none
**Successful Response** :
```200``` and JSON with attributes :
* ```status``` Always equal success if the request was successful
* ```length``` The number od masjid ojects returned
* ```data``` An array of masjid objects Each having:
* ```id``` Masjid id
* ```name``` Masjid name
* ```location``` masjid location
* ```avg_rating``` Average rating
* ```count``` Number of reviews that the Masjid has
Example JSON
```json
{
"status": "success" ,
"length": 2 ,
"data": [
{
"id": "1",
"name": "Canterbury mosque",
"location": "UK, England , Canterbury, Uni",
"avg_rating": "3.4",
"count": "16"
},
{
"id": "58",
"name": "Mosque",
"location": "1 Street, town, city, postcode, Country",
"avg_rating": "4.0",
"count": "4"
}
],
}
```
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 500,
"msg": "Error occured"
}
```
Possible erros:
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error
---
#### ```{host}/api/v1/masjid/:id```
Where ```:id``` is the id of the requested masjid
##### Request body
none
**Successful Response** :
```200``` and JSON with attributes :
* ```status``` Always equal success if the request was
* ```data``` An Masjid objects having:
* ```id``` Masjid id
* ```name``` Masjid name
* ```location``` masjid location
* ```avg_rating``` Average rating
* ```count``` Number of reviews that the Masjid has
Example JSON
```json
{
"status": "success",
"data": {
"id": "1",
"name": "Canterbury mosque",
"location": "UK, England , Canterbury, Uni",
"avg_rating": "3.4",
"count": "16"
}
}
```
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 400,
"msg": "Masjid id needs to be a number."
}
```
Possible erros:
* StatusCode : ```400``` and msg: ```"Masjid id needs to be a number."``` | Supplied id wasn't an integer.
* StatusCode : ```404``` and msg: ```"Masjid doesn't exist"``` | Masjid wasn't found.
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error.
---
#### ```{host}/api/v1/masjid/:id/reviews```
Where ```:id``` is the id of the requested masjid
##### Request body
none
**Successful Response** :
```200``` and JSON with attributes :
* ```status``` Always equal success if the request was successful
* ```length``` The number of review ojects returned
* ```data``` An array of review objects Each having:
* ```id``` Review id
* ```masjid_id``` Masjid id
* ```firstname``` Reviewer first name
* ```lastname``` Reviewer Last name
* ```review``` the review
* ```rating``` rating between 1 and 5 inclusive
Example JSON
```json
{
"status": "success",
"length": 2,
"data": [
{
"id": "66",
"masjid_id": "58",
"firstname": "Ahmed",
"lastname": "Mohamed",
"review": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Hac habitasse platea dictumst quisque sagittis purus sit amet. At volutpat diam ut venenatis.",
"rating": 5
},
{
"id": "68",
"masjid_id": "58",
"firstname": "Mohamed",
"lastname": "Ali",
"review": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Hac habitasse platea dictumst quisque sagittis purus sit amet. At volutpat diam ut venenatis.",
"rating": 4
}
]
}
```
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 400,
"msg": "Masjid id needs to be a number."
}
```
Possible erros:
* StatusCode : ```400``` and msg: ```"Masjid id needs to be a number."``` | Supplied id wasn't an integer.
* StatusCode : ```404``` and msg: ```"Masjid doesn't exist"``` | Masjid wasn't found.
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error.
### ```POST``` Requests:
---
#### ```{host}/api/v1/masjid```
##### Request body
JSON with attributes :
* ```name``` | String | Masjid name
* ```location``` | String | masjid location
Example JSON
```json
{
"name" : "Masjid Name",
"location": "Masjid Location"
}
```
**Successful Response** :
```201``` and JSON with attributes :
* ```status``` Always equal success if the request was successful
* ```data``` the created masjid object with attributes:
* ```id``` Masjid id
* ```name``` Masjid name
* ```location``` Masjid location
Example JSON
```json
{
"status": "success",
"data": {
"id": "59",
"name": "Masjid Name",
"location": "Masjid Location"
}
}
```
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 400,
"msg": "Request body needs to have name and location"
}
```
Possible erros:
* StatusCode : ```400``` and msg: ```"Request body needs to have name and location."``` | Name or location weren't supplied in the request body.
* StatusCode : ```400``` and msg: ```"name and location needs to be a string."``` | Name or location aren't string.
* StatusCode : ```400``` and msg: ```"name and location can't be empty"``` | Name or location attributes where empty.
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error.
---
#### ```{host}/api/v1/masjid/:id/reviews```
Where ```:id``` is the id of the requested masjid
##### Request body
JSON with attributes :
* ```firstName``` | String | Reviewer first name
* ```lastName``` | String | Reviewer last name
Example JSON
* ```review``` | String | Reviwe content
* ```rating``` | Integer | Rating between 1 and 5 inclusive
Example JSON
```json
{
"firstName" : "Ahmed",
"lastName" : "Mohamed",
"review" :"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Hac habitasse platea dictumst quisque sagittis purus sit amet. At volutpat diam ut venenatis.",
"rating" : 5
}
```
**Successful Response** :
```201``` and JSON with attributes :
* ```status``` Always equal success if the request was successful
* ```data``` the created masjid object with attributes:
* ```id``` Review id
* ```masjid_id``` Masjid id
* ```firstname``` Reviewer first name
* ```lastname``` Reviewer Last name
* ```review``` the review
* ```rating``` rating between 1 and 5 inclusive
Example JSON
```json
{
"status": "success",
"data": {
"id": "70",
"masjid_id": "58",
"firstname": "Ahmed",
"lastname": "Mohamed",
"review": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Hac habitasse platea dictumst quisque sagittis purus sit amet. At volutpat diam ut venenatis.",
"rating": 5
}
}
```
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 400,
"msg": "Request body needs to have firstName, lastName, review, rating"
}
```
Possible erros:
* StatusCode : ```400``` and msg: ```"Request body needs to have firstName, lastName, review, rating"``` | A required attribute weren't supplied in the request body.
* StatusCode : ```400``` and msg: ```"firstName, lastName and review needs to be a string."``` | The firstName, lastName or review supplied in the request body weren't of type string.
* StatusCode : ```400``` and msg: ```"firstName, lastName and review can't be empty."``` | The firstName, lastName or review supplied in the request body were empty.
* StatusCode : ```400``` and msg: ```"rating need to be a number between 1 and 5 inclusive."``` | The supplied rating was either not an integer, bigger than 5 or less than 1.
* StatusCode : ```400``` and msg: ```"Masjid id needs to be a number."``` | Supplied id wasn't an integer.
* StatusCode : ```404``` and msg: ```"Masjid doesn't exist"``` | Masjid wasn't found.
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error.
### ```PUT``` Requests:
---
#### ```{host}/api/v1/masjid/:id```
Where ```:id``` is the id of the requested masjid
##### Request body
JSON with attributes :
* ```name``` | String | Masjid name
* ```location``` | String | masjid location
Example JSON
```json
{
"name" : "Masjid Name",
"location": "Masjid Location"
}
```
**Successful Response** :
```200``` and JSON with attributes :
* ```status``` Always equal success if the request was successful
* ```data``` the created masjid object with attributes:
* ```id``` Masjid id
* ```name``` Masjid name
* ```location``` Masjid location
Example JSON
```json
{
"status": "success",
"data": {
"id": "59",
"name": "Masjid Name",
"location": "Masjid Location"
}
}
```
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 400,
"msg": "Request body needs to have name and location"
}
```
Possible erros:
* StatusCode : ```400``` and msg: ```"Request body needs to have name and location."``` | Name or location weren't supplied in the request body.
* StatusCode : ```400``` and msg: ```"name and location needs to be a string."``` | Name or location aren't string.
* StatusCode : ```400``` and msg: ```"name and location can't be empty"``` | Name or location attributes where empty.
* StatusCode : ```400``` and msg: ```"Masjid id needs to be a number."``` | Supplied id wasn't an integer.
* StatusCode : ```404``` and msg: ```"Masjid doesn't exist"``` | Masjid wasn't found.
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error.
### ```DELETE``` Requests:
---
#### ```{host}/api/v1/masjid/:id```
##### Request body
none
**Successful Response** :
**```204``` an empty body.**
**Error Responses :**
Error status code and JSON with attributes :
* ```status``` Always equal Fail if the request was failed
* ```statusCode``` HTTP error status code
* ```msg``` error message
Example JSON
```json
{
"status": "Fail",
"statusCode": 404,
"msg": "Faild to delete, Masjid doesn't exist."
}
```
Possible erros:
* StatusCode : ```400``` and msg: ```"Masjid id needs to be a number."``` | Supplied id wasn't an integer.
* StatusCode : ```404``` and msg: ```"Masjid doesn't exist"``` | Masjid wasn't found.
* StatusCode : ```500``` and msg: ```"Error occured"``` | internal server error.
## Contributing
This project was created for practice purposes only its not intended realword use. However any reccomndation are welcome. Wiether its a major desgin flaw or a best prctice advice please don't hesitate to open a new issue I am always happy to learn.