https://github.com/milton-art-scan/sbu-hackathon-2024-server
Milton Server: Access server-side computation resources for object detection and our growing catalog of art pieces
https://github.com/milton-art-scan/sbu-hackathon-2024-server
aws-rds computer-vision django python
Last synced: 7 months ago
JSON representation
Milton Server: Access server-side computation resources for object detection and our growing catalog of art pieces
- Host: GitHub
- URL: https://github.com/milton-art-scan/sbu-hackathon-2024-server
- Owner: Milton-Art-Scan
- Created: 2024-02-10T16:16:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-11T12:01:41.000Z (over 1 year ago)
- Last Synced: 2025-01-31T10:16:13.669Z (8 months ago)
- Topics: aws-rds, computer-vision, django, python
- Language: Python
- Homepage: https://devpost.com/software/milton-a9shl7
- Size: 3.82 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Milton: Scan Art for Info. A Platform for Artist.
This is the server for Milton, an android application for accessing context of art pieces by scanning art with Landing Lens by LandingAI.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
## Installation
To install this project, make sure you have Python 3.11+ and pip installed on your system. Clone the repository then install the dependencies using the following command in the root directory of this repository:
```bash
$ pip install -r requirements.txt
```
## Usage
To start the server execute the following in the root directory:
```bash
$ python server/manage.py runserver
```
Make the server available to your network with forward tunneling:
### Forward Tunneling with Ngrok
Download Ngrok (https://bin.equinox.io/c/bNyj1mQVY4c/ngrok-v3-stable-windows-amd64.zip)
Add your authtoken to the config file
```sh
$ ngrok config add-authtoken
```
Deploy the server in your network (Default port is 8000)
```sh
$ ngrok http http://localhost:
```
## API
Access the API Documentation at [https://documenter.getpostman.com/view/30898740/2sA2r3Yk8w](https://documenter.getpostman.com/view/30898740/2sA2r3Yk8w)