Skip to content

Commit 05a1778

Browse files
committed
readme updated with sendgrid details
2 parents 1936d7c + e3d10a0 commit 05a1778

File tree

2 files changed

+40
-15
lines changed

2 files changed

+40
-15
lines changed

.env.example

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ MONGO_URI=[your_mongo_uri]
44
JWT_SECRET=[your_jwt_secret]
55
EXPIRY=[your_jwt_expiry_time]
66
SECRET=[your_secret_for_mongostore]
7-
EMAIL=[your_email_address]
8-
PASS=[your_email_password]
97
CLOUDINARY_CLOUD_NAME=[your_cloudinary_cloud_name]
108
CLOUDINARY_KEY=[your_cloudinary_key]
119
CLOUDINARY_SECRET=[your_cloudinary_secret]
12-
MAPBOX_TOKEN=[your_mapbox_project]
10+
MAPBOX_TOKEN=[your_mapbox_project]
11+
X_RAPIDAPI_HOST=[your_rapidapi_sendgrid_host]
12+
X_RAPIDAPI_KEY=[your_rapiapi_sendgrid_key]
13+
SENDGRID_EMAIL=[no-reply@your_domain.com]

README.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,38 @@
1-
# Parkify
2-
3-
Hasslefree way to book your parking space with easy cancellations and timeline extensions
1+
<!--# Parkify-->
2+
<div align="center">
3+
<picture>
4+
<source srcset="https://res.cloudinary.com/codehackerone/image/upload/v1654404920/Parkify/logo-white_em2e4o.png" media="(prefers-color-scheme: dark)">
5+
<img alt="PARKIFY_LOGO" id="logo-dark" src="https://res.cloudinary.com/codehackerone/image/upload/v1654404897/Parkify/logo-black_y6ungi.png" height="100" />
6+
</picture>
7+
<!--<img alt="PARKIFY_LOGO" id="logo-dark" src="public/img/logo-black.png" height="100" />-->
8+
<br>
9+
<!-- <img alt="PARKIFY_TEXT" id="logo-white" src="public/img/logo-text-black.png" height="40"/> -->
10+
<picture>
11+
<source srcset="https://res.cloudinary.com/codehackerone/image/upload/v1654404904/Parkify/logo-text-white_jqhdsf.png" media="(prefers-color-scheme: dark)">
12+
<img alt="PARKIFY_TEXT" id="logo-dark" src="https://res.cloudinary.com/codehackerone/image/upload/v1654404900/Parkify/logo-text-black_qnvhtr.png" height="40" />
13+
</picture>
14+
<br><br>
15+
<span style="font-weight: bold;">&#60;/&#62;</span> with <span style="color: #8b0000;">&hearts;</span> by <a href="https://github.com/codehackerone">@codehackerone</a>.<br><br>
16+
<p align="center">
17+
<img src="https://img.shields.io/badge/version-1.0.0-yellowgreen" alt="version 1.0.0"/>
18+
<img src="https://img.shields.io/badge/license-MIT-brightgreen" alt="license MIT"/>
19+
<img src="https://img.shields.io/github/issues-pr-raw/codehackerone/parkify.svg" />
20+
<img src="https://img.shields.io/github/issues-raw/codehackerone/parkify.svg"/>
21+
<img src="https://img.shields.io/badge/author-Codehackerone-orange" alt="author codehackerone"/>
22+
</p>
23+
</div>
24+
<br>
25+
26+
> Hasslefree way to book your parking space with easy cancellations and timeline extensions<br>
427
528
---
6-
7-
## ![cover image](https://github.com/Codehackerone/parkify/blob/main/public/img/coverpage.png)
8-
29+
![cover image](https://github.com/Codehackerone/parkify/blob/main/public/img/coverpage.png)
30+
---
931
## Why Parkify?
1032

1133
The application will make it easier for the drivers to find and pre-book their slots at the parking locations. The application will also save the frustration of the drivers who at times out of urgency park their cars on the street itself, which further adds to the traffic in the locality. With the use of the application, business professionals can focus on their daily tasks and not worry about their parking space.
1234

35+
1336
## Built With
1437

1538
This application is built on nodeJS, typed in javascript. Vanilla html-css-js is used to built the frontend.
@@ -67,12 +90,13 @@ Create a `.env` file then edit it with your settings. You will need:
6790
- JWT_SECRET=[your_jwt_secret]
6891
- EXPIRY=[your_jwt_expiry_time]
6992
- SECRET=[your_secret_for_mongostore]
70-
- EMAIL=[your_email_address]
71-
- PASS=[your_email_password]
7293
- CLOUDINARY_CLOUD_NAME=[your_cloudinary_cloud_name]
7394
- CLOUDINARY_KEY=[your_cloudinary_key]
7495
- CLOUDINARY_SECRET=[your_cloudinary_secret]
7596
- MAPBOX_TOKEN=[your_mapbox_project]
97+
- X_RAPIDAPI_HOST=[your_rapidapi_sendgrid_host]
98+
- X_RAPIDAPI_KEY=[your_rapiapi_sendgrid_key]
99+
- SENDGRID_EMAIL=[no-reply@your_domain.com]
76100

77101
### Running the project
78102

@@ -84,10 +108,11 @@ Create a `.env` file then edit it with your settings. You will need:
84108

85109
## License
86110

87-
`Parkify` is available under the MIT license. See the LICENSE file for more info.
111+
```Parkify``` is available under the MIT license. See the LICENSE file for more info.
88112

89113
## Contributing
90114

115+
91116
1. Find an issue to work on from [here](https://github.com/codehackerone/parkify/issues)
92117
2. Ask the owner/maintainer for permission to work on the issue.
93118
3. Fork this repository. [For help, click here](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
@@ -99,6 +124,5 @@ Create a `.env` file then edit it with your settings. You will need:
99124

100125
Please read `CODE_OF_CONDUCT.md` for details on the code of conduct, and the process for submitting pull requests.
101126

102-
---
103-
104-
This repo is crafted with <span style="color: #8b0000;">&hearts;</span> and owned/maintained by <a href="https://github.com/codehackerone">@codehackerone</a>.
127+
---
128+
This repo is owned/maintained by <a href="https://github.com/codehackerone">@codehackerone</a>.

0 commit comments

Comments
 (0)