Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pratyush1712/aigeolocator
https://github.com/pratyush1712/aigeolocator
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/pratyush1712/aigeolocator
- Owner: pratyush1712
- Created: 2023-10-15T19:02:25.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-06T22:56:49.000Z (about 1 year ago)
- Last Synced: 2024-11-07T04:14:11.657Z (about 2 months ago)
- Language: Jupyter Notebook
- Homepage: https://graft.onrender.com
- Size: 4.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Graft - Flask based web application for Demonstration
This guide provides detailed instructions on how to set up, run, and deploy the Flask based web application for demonstrating the Graft project.
## Initial Setup
1. **Prepare the Model Folder**:
- Place the `data.txt` file in the `model` folder.
- Place the `MA_2020.npz` file in the `model` folder.
2. **Environment Configuration**:
- Place the `.env` file in the root directory of the project. Ensure all necessary environment variables are set in the `.env` file for proper configuration.
```
export FLASK_ENV=production
export IMAGE_SOURCE=https://research.cs.cornell.edu/caco/data/graft/MA/
```
3. **Virtual Environment (venv) Setup**:
- It's recommended to use a virtual environment to isolate the project dependencies. To set up a virtual environment, navigate to the project root and run:
```bash
python3 -m venv venv
```
- Activate the virtual environment:
- On macOS and Linux:
```bash
source venv/bin/activate
```
- On Windows:
```bash
.\venv\Scripts\activate
```
- Install the required dependencies using the provided `requirements.txt` file:
```bash
pip install -r requirements.txt
```
## Running the Application Locally
- To run the application, navigate to the project root and run:
```bash
python app.py
```
- The application will be accessible at `http://localhost:8080/`.
## Deploying the Application
1. ### Gunicorn
- To deploy the application, navigate to the project root and run:
```bash
gunicorn --bind 0.0.0.0 app:app
```
- The application will be accessible at `http://:8000/`.
2. ### Docker
If you're using Docker for deployment, follow the steps below:
#### Build the image:
- For Local Testing:
```bash
docker build --build-arg FLASK_ENV=development -t graft .
```
This command sets the Flask environment to development mode and builds the Docker image with the tag graft.
- For Production set up
```bash
docker build -t graft .
```
This command sets the Flask environment to the default production mode and builds the Docker image with the tag graft.
#### Spin up a container
```bash
docker run -p 8080:8080 graft --name prod
```
This command spins up a container with the name prod.