go-file-explorer

Go File Explorer

Introduction

This tool provides you a very lightweight interface to navigate through a file system. It was developed to provide a UI to a NAS project running on a Raspberry Pi 3B+.

Prerequisite

• Golang with a working workspace (GOPATH, GOROOT...)

Installation

Clone the repository in your Gopath (usually $GOPATH/src/)

git clone git@github.com:cyprille/go-file-explorer.git $GOPATH/src/go-file-explorer

Enter the project

cd $GOPATH/src/go-file-explorer

Launch the install command

make install

Fill in the .env file at the project root with your parameters

Run

Run the application in development mode

Start the app

go run main.go

Then, open your browser and navigate to http://localhost:SERVER_PORT. The SERVER_PORT variable is the one you defined in the .env file.

Run the application in production mode

Build the app

go build

Start the app

./go-file-explorer

Then, open your browser and navigate to http://localhost:SERVER_PORT. The SERVER_PORT variable is the one you defined in the .env file.

Set the application as a background service

Copy the service file to your systemd

sudo cp ressources/go-file-explorer.service /etc/systemd/system/

Run the following command to start the service

sudo systemctl start go-file-explorer

Run the following command to auto start the service on boot

sudo systemctl enable go-file-explorer

Deploy

Automated update

If you want to automatically update the app from the main repository, I suggest the use of the extremely simple Git-Auto-Deploy.

Code of conduct

See CODE_OF_CONDUCT.md

Contributing

See CONTRIBUTING.md

Licence

This project is licended under the MIT licence.

See LICENCE.md