fauzan-radji / videotron

Electron based video player with a simple and clean interface.

Videotron

Electron based video player with a simple and clean interface.
Download »
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Platform Support
2. Installation
3. Build On Your Own
4. Publishing
5. Contributing
6. Contact

About The Project

Videotron is a simple video player built with Electron.js. It has a clean and simple interface that is easy to use. It is a great alternative to the default video player on your computer.

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Platform Support

• ❌ Windows
• ❌ MacOS
• ✔️ Linux

By this time, Videotron only supports Linux. Support for other platforms will be added in the future. But if you want to build it on your own, you can follow the steps in the Build On Your Own section.

(back to top)

Installation

1. Download the latest release from the releases page
2. Extract the zip file
3. Run the executable file
4. Enjoy!

(back to top)

Build On Your Own

To build the application on your own, follow these steps:

1. Clone the repo

   # HTTPS
   git clone https://github.com/fauzan-radji/videotron.git
   
   # SSH
   git clone [email protected]:fauzan-radji/videotron.git

2. Install NPM packages

    npm install

3. Build the project

   npm run make

4. The executable file will be in the out/make/ folder.

(back to top)

Publishing

1. To publish the application you need to generate a GitHub token and give it the public_repo scope.

2. Copy the .env.example file to .env and fill in the GITHUB_TOKEN field with the token you just generated.

   cp .env.example .env

3. Run the following command to publish the application.

   npm run publish

   This will create a draft release on GitHub.

4. To release the application to the public, you can go to the releases page on GitHub and edit the draft release. Change the draft to a release and publish it. The release will be available for download on the releases page.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

LinkedIn - Tri Putra Fauzan H. Radji

Project Link: https://github.com/fauzan-radji/videotron

(back to top)