parkAway

parkAway is a parking service where clients can post parking lots for rent, and users/customers can send a request to make a deal/contract. It's a kind of Airbnb for parking lots.

Key Highlights

parkAway allows users to register an account, view parking lots available for rent, and send rental requests to the owners of the parking lots. Owners can post parking lots for rent, view requests from potential renters, and accept or decline rental requests. Users can view their rental history and owners can view their rental revenue.

Screenshot

Future Development

Some future development plans for parkAway include:

• Adding location-based listings
• Adding a payment gateway for users to pay for parking rentals directly through the app
• Adding more types of parking spaces, such as RV parking and boat parking

Technologies Used

• React.js
• Express.js
• Node.js
• MongoDB
• Bootstrap
• Twilio

Installation

To run this project locally, follow these steps:

• Server:

1. Clone this repository
2. Change the directory cd server
3. Install dependencies by running npm install
4. Create a .env file in /server and add your links based on server/.env_sample
5. Run the server with node server.js

• Client:

1. Change the directory cd client
2. Install dependencies by running npm install
3. Run the client with npm start

Contributing

To contribute to WinterFind, follow these steps:

1. Fork this repository.
2. Clone your forked repository to your local machine.
3. Create a new branch: git checkout -b my-new-feature.
4. Make your changes and commit them: git commit -am 'Add some feature'.
5. Push your changes to the branch: git push origin my-new-feature.
6. Submit a pull request.

Pull Requests

We welcome pull requests from everyone. Please ensure your pull request adheres to the following guidelines:

1. Explain the problem your pull request solves.
2. Make sure your changes are well-tested and documented.
3. Ensure your code follows the coding conventions and standards used in the project.
4. Ensure your code is properly formatted using Prettier.
5. Make sure your commits are descriptive and have a clear message.

Read more on creating a pull request from a fork here.

Issues

If you find any issues with WinterFind, please submit them through the GitHub Issues page. When submitting an issue, please provide the following information:

1. A clear and descriptive title.
2. Steps to reproduce the issue.
3. Expected behavior.
4. Actual behavior.
5. Screenshots or code snippets (if applicable).

License

This project is licensed under the MIT License.

Contributers

We would like to thank the following people and resources for their help:

• Om Dalwadi - OmDalwadi
• Satyam Singh - Klaus
• Kartik Patel - kpatel0170