https://github.com/binghuan/simple_file_storage_server

Coding quest from Woven Planet
https://github.com/binghuan/simple_file_storage_server

assignment backend go javascript server take-home-test webapp

Last synced: 13 days ago
JSON representation

Coding quest from Woven Planet

• Host: GitHub
• URL: https://github.com/binghuan/simple_file_storage_server
• Owner: binghuan
• Created: 2021-11-27T04:25:40.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-12-18T18:41:52.000Z (about 3 years ago)
• Last Synced: 2023-08-02T04:08:49.630Z (over 1 year ago)
• Topics: assignment, backend, go, javascript, server, take-home-test, webapp
• Language: Go
• Homepage:
• Size: 18.9 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![](./frontend/images/icon-256.jpg)  

Simple File Storage Server

================================================

This is a simple file storage server.   

User can upload file,  delete file and list file on the server. 

If you want to build and run the server locally, here is the user guide. 

## Table of Contents

- [Simple File Storage Server](#simple-file-storage-server)

  - [Table of Contents](#table-of-contents)

  - [On Server Side](#on-server-side)

    - [Prepare your Go Environment](#prepare-your-go-environment)

    - [Start Back-End Server](#start-back-end-server)

  - [On Front-End Side](#on-front-end-side)

    - [Start Web Server to interact with server](#start-web-server-to-interact-with-server)

  - [Control flow for web app](#control-flow-for-web-app)

  - [How to run test cases](#how-to-run-test-cases)

  - [Demo on WebSite](#demo-on-website)

  - [How to Use CLI for Testing.](#how-to-use-cli-for-testing)

  - [Demo on CLI](#demo-on-cli)

  - [Use Docker to start the server](#use-docker-to-start-the-server)

## On Server Side

### Prepare your Go Environment

Download and install  

  

### Start Back-End Server

Start the go server and listen the port 8080

```shell

cd backend;

go run main.go

```

Here is the APIs provided by Server 

![](./APIs.png)

## On Front-End Side

### Start Web Server to interact with server 

You can use your favorite http-server.

(in this case, I use this https://formulae.brew.sh/formula/http-server)

```

cd frontend;

http-server --cors;

```

After launching the web server, you can visit the website. 

![](./webpage.png)  

Now, you can choose file to upload.  

Once you have uploaded a file (ex: mylogo.png), 

you can see there will be a file on the list. 

![](./webpage_list.png)

## Control flow for web app

![](./control_flow_for_web_app.png)

## How to run test cases

```shell

cd backend; 

go test -v ./

```

![](./demo_testcases.png)

## Demo on WebSite

![](./demo_20211127.gif)

## How to Use CLI for Testing. 

- Command to Upload file to server 

```shell

curl -v -F filename=image.jpg \

    -F [email protected] \

    http://localhost:8080/files/mylogo.png

```

- Command to list files on server

```shell

curl --location --request GET 'http://localhost:8080/files'

## Sample of output 

## {"files":["mylogo.png"]}

```

- Command to delete files on server 

```shell

curl --location --request DELETE 'http://localhost:8080/files/mylogo.png'

```

## Demo on CLI

![](./demo_cli.gif)

## Use Docker to start the server

Input following command in the root folder.

Then, visit the website "http://localhost:8081"

```shell

docker-compose up -d

```

![](./demo_docker-compose.gif)