Skip to content

Commit 4b4a768

Browse files
Update README.md
1 parent 3593f08 commit 4b4a768

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

README.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,19 @@
11
# Parkify
22

3-
A simple way to solve your complex parking issues.
3+
Hasslefree way to book your parking space with easy cancellations and timeline extensions
44

55
---
66
![cover image](https://github.com/Codehackerone/parkify/blob/main/public/img/coverpage.png)
77
---
8+
## Why Parkify?
9+
10+
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, the business professionals will not have to keep an extra time just for parking their car between the meetings and will plan theirs in a much better way.
11+
12+
13+
## Built With
14+
15+
This application is built on nodeJS, typed in javascript. Vanilla html-css-js is used to built the frontend.
16+
817
## Requirements
918

1019
For development, you will only need Node.js and a node global package, npm, installed in your environement.
@@ -42,13 +51,13 @@ If you need to update `npm`, you can make it using `npm`! Cool right? After runn
4251

4352
---
4453

45-
## Install
54+
## Installation
4655

4756
$ git clone https://github.com/codehackerone/parkify
4857
$ cd parkify
4958
$ npm install
5059

51-
## Configure environmental variables
60+
### Configure environmental variables
5261

5362
Create a `.env` file then edit it with your settings. You will need:
5463

@@ -65,8 +74,31 @@ Create a `.env` file then edit it with your settings. You will need:
6574
- CLOUDINARY_SECRET=[your_cloudinary_secret]
6675
- MAPBOX_TOKEN=[your_mapbox_project]
6776

68-
## Running the project
77+
### Running the project
6978

7079
$ npm start
7180
or
7281
$ npx nodemon
82+
83+
---
84+
85+
## License
86+
87+
```Parkify``` is available under the MIT license. See the LICENSE file for more info.
88+
89+
## Contributing
90+
91+
92+
1. Find an issue to work on from [here](https://github.com/codehackerone/parkify/issues)
93+
2. Ask the owner/maintainer for permission to work on the issue.
94+
3. Fork this repository. [For help, click here](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
95+
4. Clone the forked repository in your local machine [For help, click here](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
96+
5. Create a new branch [For help, click here](https://github.com/Kunena/Kunena-Forum/wiki/Create-a-new-branch-with-git-and-manage-branches)
97+
6. Add and commit your changes to the new branch [For help, click here](https://stackoverflow.com/questions/14655816/how-to-commit-changes-to-another-pre-existent-branch#:~:text=First%2C%20checkout%20to%20your%20new,show%20up%20on%20the%20remote.)
98+
7. Create a Pull Request, add proper description, screenshots, comments and ask a review from owner/maintainer [For help, click here](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
99+
8. The owner/developer will merge the Pull Request if it aligns with the practises we follow and is valid. One should not merge, and ask for a reviewer to merge it.
100+
101+
Please read `CODE_OF_CONDUCT.md` for details on the code of conduct, and the process for submitting pull requests.
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>.

0 commit comments

Comments
 (0)