Welcome to the Parking Lots Notifier API repository! This project aims to provide an easy-to-use API for real-time parking lot availability notifications. It's built with Node.js and designed to be scalable and efficient, perfect for anyone looking to integrate parking lot data into their applications.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Node.js
- npm
First, clone the repository to your local machine: git clone https://github.com/parkingLotsNotifier/API.git
Then, navigate to the project directory: cd API
Install the project dependencies: npm install
Configuration files can be found in the config directory. Ensure you update these with your own settings (e.g., database connection details, API keys) before running the application.
Start the application with the following command: node app.js
The API should now be up and running, listening for requests.
We welcome contributions from everyone. Here are some ways you can contribute:
- Reporting bugs
- Suggesting enhancements
- Submitting pull requests