README.md
Seamless Finance: Docker-Deployed APIs for Smart Investments.
Docker | Discussion | Bugs/Issues | Contribute |
---|---|---|---|
Get started quickly using Docker | Join/Read the Community Discussion | Raise an Issue about a Problem | Contribute With New Features |
Fin-Maestro-Kin empowers you to:
- 📊Effortlessly Fetch Historical Data: Seamlessly fetch historical financial data for in-depth analysis and market trend identification.
- 📈Perform Market Trend Analysis: Uncover valuable insights and identify market trends with ease, guiding your investment decisions.
- 📉Evaluate Market Sentiment: Gauge market sentiment to make informed investment decisions based on current market psychology.
- ⚡Experience Lightning-Fast Performance: Benefit from the performance and scalability of FastAPI for a seamless user experience.
- 🔍Craft Unparalleled Market Insights: Build your own financial applications powered by Fin-Maestro-Kin, unlocking a deeper understanding of the market.
Running Fin-Maestro-Kin in a Docker Container
Manually with Docker Command Line Interface (CLI)
- Pull the Docker Image: First, pull the pre-built Docker image from Docker Hub using the following command in your terminal or command prompt:
docker pull devfinwiz24/fin-maestro-kin:latest
- Run the Docker Container: After pulling the image, run the Docker container using the following command:
This command pulls the latest version of the Docker image from Docker Hub and runs it in a detached mode (docker run -d -p 8000:8000 devfinwiz24/fin-maestro-kin:latest
-d
) while mapping port 8000 of the host machine to port 8000 of the container (-p 8000:8000
).
Using Docker Desktop (Optional)
Prerequisite: Download Docker Desktop
- Pull the Docker Image:
- Open Docker Desktop and navigate to the "Images" section.
- Search for the pre-built Docker image named
devfinwiz24/fin-maestro-kin:latest
. - Click on the image and select "Pull" to download it to your local machine.
- Run the Docker Container:
- Once the image is pulled, navigate to the "Containers/Apps" section in Docker Desktop.
- Click on "Run" and configure the container settings, such as container name(optional), port mapping (mandatory - 8000 for example).
- Start the container to launch the application.
- Access the Application:
- After the Docker container is running, access the application by opening a web browser.
- Enter http://localhost:8000/docs in the address bar to access the Fin-Maestro-Kin API documentation.
- Additional Docker Desktop Features:
- Docker Desktop provides a user-friendly graphical interface for managing Docker containers.
- You can monitor container status, view container logs, and interact with running containers using the Docker Desktop GUI.
Usage
After deploying the container, interact with Fin Maestro Kin by sending HTTP requests to the exposed endpoints. Refer to the API documentation for detailed information on available endpoints and request formats.
Last modified: 7 months ago