This project provides an easy and straightforward way to use Google's V8 engine in a Docker container, eliminating the need to install and configure V8 on your local machine.
This project is a docker image with a flexible and customizable entrypoint script that provides an isolated environment to run javascript programs with Google V8 engine.
It allows you to easily test and develop code without worrying about dependencies and setup V8.
The purpose of this project is to provide a pre-configured Docker image for developers who require the V8 engine.
This project solves the problem of setting up and configuring V8 on your local machine, which can be time-consuming and challenging, especially for beginners. With this docker image, you can run V8 engine in a container with a single command, making it easy to start experimenting with V8.
Quera website uses V8 engine to evaluate JavaScript solutions. Installing this engine is a difficult task, so I decided to develop this project to solve this problem, practice Docker and Python and have some fun!
This project is forked from the andreburgaud project which is a very good project. The problem of that project was that its entrypoint was not flexible and convenient.
My project supports various commands. Especially the new run command that allows you to run javascript programs with several input files with one line and see the result. I also changed the address of the entrypoint file so that it is easier to replace or complete it with a desired entrypoint.
It is also tried to use the best structures in this project. For example, using test cases, tox, git hooks, GitHub actions, etc. This makes it easier to maintain the project in the future.
This project aims to make it easier for developers to use the V8 engine by providing a Docker image that can be easily installed and configured. By using this image, developers can save time and effort that would otherwise be spent on setting up and configuring the V8 engine.
Docker Entrypoint: Python 3.8
To use this project, you will need to have Docker installed on your system. Docker can be downloaded from the official website: https://www.docker.com/get-started
To use this project, you can simply pull the Docker image from Docker Hub using the following command:
docker pull hamidmolareza/d8Once you have pulled the image, you can run it using the following command:
docker run --rm -it hamidmolareza/d8 --helpRun a javascript program with parameters:
docker run --rm -it hamidmolareza/d8 run /samples/hello-world.jsIf you want to run a JavaScript file that is in your local system:
Suppose your file name is program.js
docker run --rm -it -v $PWD:/src hamidmolareza/d8 run /src/program.jsIn v8, user input can be obtained using the readline() function. If your application needs to receive input from the user, it is very difficult to enter the input manually every time during development. The run command is there to make your work easier.
1- Create a file called input.txt and save your desired input in it.
Note: Leave a blank line at the end of the file
2- With the help of -f, you can specify the path of the file to be sent to the program:
docker run --rm -it -v $PWD:/src hamidmolareza/d8 run /src/program.js -f input.txtYou may have multiple inputs. no problem! Put them in a folder and give its path to the program with the help of -d. The program gathers all the files in the folder and gives it to the program and displays the result of each one separately.
docker run --rm -it -v $PWD:/src hamidmolareza/d8 run /src/program.js -f input.txt -d my-folderA ready-made example:
docker run --rm -it hamidmolareza/d8 run /samples/say-hello.js -f /samples/sample-inputs/0.txt -d /samples/sample-inputsDon't worry about repetition in addressing. The program ignores duplicate files (considers only once)
Run enhanced d8 shell with the given parameters:
docker run --rm -it hamidmolareza/d8 shellBy default, this command adds options like --harmony and --allow-natives-syntax.
--harmony enables the use of ECMAScript 6 (ES6) features, which is the latest version of the ECMAScript specification. This includes features such as arrow functions, template literals, and let and const variables.
--allow-natives-syntax allows the use of certain low-level syntax in the D8 Shell command, which provides access to the V8 engine's internal functionality. This includes the ability to call native functions directly, and access to certain built-in objects and properties. This option is useful for debugging and testing purposes, but should be used with caution, as it can cause security vulnerabilities if used incorrectly.
Also, this command use rlwrap -m -pgreen:
The rlwrap is a utility that provides command line editing and history for any input line. It allows users to use arrow keys for navigation, and provides other features such as tab completion, command history search, and line editing.
The -m option for rlwrap enables mouse support, which allows users to use the mouse for navigation and selection within the shell command.
The -pgreen option for rlwrap enables colorization of output, making it easier to read and distinguish between different types of output.
Run default d8 shell with the given parameters:
docker run --rm -it hamidmolareza/d8 d8Run bash shell with the given parameters:
docker run --rm -it hamidmolareza/d8 bashUse --help to see more commands.
docker run --rm -it hamidmolareza/d8 --helpThe entrypoint is the starting point of Docker image.
When docker run --rm -it hamidmolareza/d8 is called, all parameters are passed to a shell script called entrypoint.sh. By changing this file (temporarily or permanently) you can customize the behavior of the image.
1- Create a file called entrypoint.sh and write your commands. For example:
#!/bin/bash
echo 'Hello from custom entrypoint!'
echo 'This call d8...'
d8
2- Give this file the necessary access level to run:
chmod +x entrypoint.sh3- Use this command:
docker run --rm -it -v $PWD:/entrypoint hamidmolareza/d81- Create a file called entrypoint.sh and write your commands. For example:
#!/bin/bash
echo 'Hello from custom entrypoint!'
echo 'This call d8...'
d8
2- Give this file the necessary access level to run:
chmod +x entrypoint.sh3- Transfer the created file to Docker with the help of the following command:
docker run --rm -it -v $PWD:/src hamidmolareza/d8 bash4- In docker, copy the new file over the previous file:
cp /src/entrypoint.sh /entrypoint/entrypoint.sh5- Open new terminal (outside of docker image) and get v8 container id with this command:
docker ps6- Commit the image with a new name:
docker commit DOCKER_ID my-new-v8-name7- Use your new docker image:
docker run --rm -it my-new-v8-namePlease see the CHANGELOG.md file.
This project provides the following features:
- A pre-configured Docker image for the V8 engine.
- Easy to use and configure
- Provides an isolated environment to run V8 applications and scripts
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests ( Add your votes using the 👍 reaction)
- Top Bugs ( Add your votes using the 👍 reaction)
- Newest Bugs
Reach out to the maintainer at one of the following places:
Q: What is the V8 engine?
A: The V8 engine is a high-performance JavaScript engine developed by Google that powers Google Chrome and Node.js. The V8 engine is commonly used for server-side JavaScript applications, but it can also be used for client-side applications and embedded systems.
Q: What is Docker?
A: Docker is a platform that allows developers to easily create, deploy, and run applications in containers.
If you want to say thank you or/and support active development of PROJECT_NAME:
- Add a GitHub Star to the project.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make it better!
First off, thanks for taking the time to contribute! Contributions are what make the free/open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
This project uses conventional commits, so please follow the specification in your commit messages.
Please read our contribution guidelines, and thank you for being involved!
The original setup of this repository is by Hamid Molareza.
For a full list of all authors and contributors, see the contributors page.
The V8 Docker Image follows good practices of security, but 100% security cannot be assured. This project is provided "as is" without any warranty.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the GPLv3.
See LICENSE for more information.
This project is forked from andreburgaud.