Skip to content

Latest commit

 

History

History
62 lines (37 loc) · 3.07 KB

README.md

File metadata and controls

62 lines (37 loc) · 3.07 KB

ViLoW

Go Report Card Codacy Badge Maintainability go.dev reference

ViLoW is a system that displays videos shared by the user on a platform for access on mobile devices or desktop on home network.

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Installing

  • After installing the tools mentioned above you are ready to run the application and / or contribute to the project.

  • Now you can clone this ViloW Server, ViLoW Client and open it in your favorite editor, I recommend VSCode! :)

You need to modify some paths for everything to work properly

  • By default, the volume folder where videos should be stored is C:\data, but you can easily modify this in the Docker-compose file.

  • Now you can run: docker-compose up --build

Built With

  • Go SQL Driver - The mysql driver used
  • Mux - A powerful HTTP router and URL matcher for building Go web servers
  • MySQL - is a relational database management system based on SQL – Structured Query Language.
  • Docker - Docker provides a way to run applications securely isolated in a container, packaged with all its dependencies and libraries.

The client was built using Reactjs, check it out:

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details