This is a desktop application to get information about apartments from apartments.com. It uses Carlo, React, and TypeScript.
-
git
-
A Bing Maps API key. You can follow this guide to obtain a key. Make sure to have the key for the installation section. The key type should be basic and the application type should be Dev/Test.
- In a terminal, navigate to a folder where you'd like the code to be downloaded. Run
git clone https://github.com/nickspencer2/apartmentsscraper.git
- Run
cd apartmentsscraper
- Run the below command. This will install the application's dependencies. It might take a little while.
npm install
-
Edit the example.config.json file in the src directory. Inside the quotes on the right side of "bingmapsapikey": paste your Bing Maps API key. Save the file. Rename it to config.json (remove the "example." prefix).
-
Run
npm start
to start the application.
If everything was successfully installed,
npm start
should launch the application and you should see a form asking for work address information.
This address is used to search apartments.com, and to calculate distance/commute times (hence needing a Bing Maps API key).
You could supply any address, it doesn't necessarily need to be a work address.
For example, one could enter the address of the Empire State Building in the form:
-
Address: 20 W 34th St
-
City: New York
-
State: NY
-
Postal Code: 10001
Once you've entered an address to calculate distance from, click the Submit button.
You should see a table with a row for each apartment complex. These will list fields with a link to the apartments.com listing, the apartment complex's location, its name, the drive duration (in minutes), and its drive distance (in miles).
There will also be an Items button, which will take you to a page with the apartment complex's listings in a table. Once you're on an apartment complex's page, you can click the back button to go back to the table of apartment complexes.