m3yevn/ftp-seer-api

🔘 FTP Seer API : A backend server for browsing FTP directory

FTP Seer - A Backend for browsing FTP directory 📦

by m3yevn and team

This API server is used to accept host,port,path,username and password to
connect FTP server and send back directory data.

Read this in Simplified Chinese - 看简体中文版本 README.zh-cn

🐳 Docker Public Repository

FTP Seer API server is available as docker image also. Run this docker command to get it up and running. Docker CLI must be installed beforehand.

$ docker pull m3yevn/ftp-seer:latest
$ docker run -d --name ftp-seer -p 5050:5050  m3yevn/ftp-seer:latest

Now, FTP Seer is accessible at 5050 port of your workstation.

📮 Request Query Params

• 1️⃣ Hostname
• 2️⃣ Port
• 3️⃣ Path
• 4️⃣ Username
• 5️⃣ Password

📧 Sample Request

**"\directory?host=sample&port=21&path=sample&username=sample&password=sample"**

**"\file?host=sample&port=21&path=sample/sample.txt&username=sample&password=sample"**

⚡ Try it on demo

• Visit this demo
• The demo uses speedtest.tele2.net for testing

✉️ HTTP Methods

Method	Route	Description
GET	"/"	Getting API health
GET	"/directory"	Listing directory of FTP server
GET	"/file"	Getting content of a file in FTP server

📚 Tech Stack

• NodeJS
• Express Framework
• JS FTP
• JSON

❤️ Run this code with

$ npm install
$ node server.js

ftp-seer-api's Issues

Adding circle-ci

One to-do task for adding circle-ci config