nicesoul / challenge-api-deployment

challenge-api-deployment

Immo Eliza prediction API

This is an API to get real estate predictions based on input data.

Table of Contents

1. About The Project
   • Built With
2. Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

During my training with BeCode, I created this API project.

Built With

• Python 3.8.10

Installation

1. Clone the repo

   git clone https://github.com/Pablousse/challenge-api-deployment.git

2. Install dependencies

   pip install -r requirements.txt

Usage

Go to the API folder of the repo and run the API on your local machine

$ python3 app.py 

Or go to https://arnaud-durieux-api-deployment.herokuapp.com/ for the online version.

The documentation on how to use the API can be found on https://arnaud-durieux-api-deployment.herokuapp.com/docs

Contributing

Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Arnaud Durieux - [e-mail]

Project Link: https://github.com/Pablousse/challenge-api-deployment