pwablito / rental_management

A Vue.js/Flask application for managing apartment rentals

Rental Management

An application to manage apartment rentals

API KEY

To setup the Google Maps API, you must obtain an API key. For information on how to get the key, visit the Google Maps API Console.

Once you have the key, place it in client/src/main.js where it says <INSERT_API_KEY_HERE>

Now, the production and development servers should work.

Production

The production server can be deployed with Docker Compose. To setup and run the server, use docker-compose up.

Development server

To setup database:

./setup_db.sh

To run development server:

./run.sh

Then navigate to http://127.0.0.1/ in your browser

Tests

To run tests:

./test.sh

Documentation

For documentation on the API, see API.md

Author: Paul Spencer

rental_management's Issues

Cleaner way to include API key

Google Maps API key should be passed in via environment variable on a docker run command rather than manually adding it to a file before building the container.

This will allow the built container to be pushed to container repo and run by anyone (as long as they pass in the API key appropriately)