Skip to content

Latest commit

 

History

History
284 lines (183 loc) · 9.84 KB

README.md

File metadata and controls

284 lines (183 loc) · 9.84 KB
Raw

Vail

Dockerize Your JavaScript/TypeScript Apps Effortlessly.

Preview
Shadow

Introduction

Vail provides a Docker powered local development experience for JavaScript/TypeScript Apps that is compatible with macOS, Windows (WSL2), and Linux.

Other than Docker, no software or libraries are required to be installed on your local computer before using Vail. Vail's simple CLI means you can start building your application with MySQL, Adminer, MinIO and other services without any previous Docker experience.

Inspiration

Vail is inspired by Laravel Sail.

Installation & Setup

You can install Vail using either NPM or Yarn.

NPM

To install Vail via NPM, use the following command:

npm install vail

Yarn

Alternatively, you can install via Yarn using this command:

yarn add vail

Installing for Existing Applications (without having Nodejs locally)

If you are developing an application with a team, you may not be the one that initially creates the application. Therefore, none of the application's node_module dependencies, including Vail, will be installed after you clone the application's repository to your local computer.

You may install the application's node_module dependencies by navigating to the application's directory and executing the following command. This command uses a small Docker container containing Nodejs to install the application's dependencies, including Vail:

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v "$(pwd):/var/www/html" \
    -w /var/www/html \
    node:20-slim \
    npm install vail

When using the node:20-slim image, you should use the same version of Nodejs that you plan to use for your application.

Setup

After Vail has been installed, you may run the vail init command. This command will publish Vail's docker-compose.yml file to the root of your application:

./node_modules/.bin/vail init

Starting Vail

After setting up Vail, you can start it by running the following command:

./node_modules/.bin/vail up

This command will start Vail and all the containers defined in your docker-compose.yml file.

Stopping Vail

To stop all of the containers, you may simply press Control + C to stop the container's execution. Or, if the containers are running in the background, you may use the stop command:

./node_modules/.bin/vail stop

Customization

Since Vail is just Docker, you are free to customize nearly everything about it. After the installation, you may wish to change the env values or change the command to start your server in the docker-compose.yml file. After doing so, rebuild your application's containers using the build command.

./node_modules/.bin/vail build --no-cache

Executing Commands

Vail supports all Docker Compose commands. You can use them as you would normally do with Docker Compose.

Additionally, you can use Vail to run any command within the context of your application's containers. For example, to check the Node.js version installed in your app container, you can run:

./node_modules/.bin/vail exec app node --version

Configuring A Shell Alias

Instead of repeatedly typing ./node_modules/.bin/vail to execute Vail commands, you may wish to configure a shell alias that allows you to execute Vail's commands more easily:

alias vail='[ -f vail ] && sh vail || sh node_modules/.bin/vail'

To make sure this is always available, you may add this to your shell configuration file in your home directory, such as ~/.zshrc or ~/.bashrc, and then restart your shell.

Once the shell alias has been configured, you may execute Vail commands by simply typing vail.

vail up

Available Services

Vail supports the following services:

Multiple Node version

This service allows you to run your application with different Node.js versions without the need of installing them on your local machine. This gives you the flexibility of testing your application with various Node.js versions.

MySQL

MySQL is a popular open-source relational database management system. Vail provides a pre-configured MySQL server.

The default config:

  • Host: mysql
  • Port: 3306
  • Username: vail
  • Password: password

Adminer

Adminer is a full-featured database management tool. It allows you to access and manage your databases, not only MySQL but also PostgreSQL and many other relational databases are supported.

Adminer can be accessed at http://localhost:8080 (default configuration).

Adminer

Redis

Redis is an open-source in-memory data structure project implementing a distributed, in-memory key-value database with optional durability.

The default config:

  • Port: 6379

MinIO

MinIO delivers AWS S3 compatible high-performance object storage. It provides the ability to store large amounts of unstructured data. In Vail, a pre-configured MinIO server is included.

MinIO can be used to mock AWS S3 bucket in the local development environment. This is particularly handy while developing features that interact with S3 but you don't want to incur unnecessary AWS costs. To setup MinIO to act as an AWS S3 bucket:

  1. Access the MinIO dashboard via http://localhost:8900.

    MinIO dashboard

  2. Login using the MinIO root user and password provided in the Vail setup.

    The default credentials:

    • Username: vail
    • Password: password

  3. Create a new bucket, which will act as your S3 bucket.

  4. For your application, use the MinIO host, bucket name, access key, and secret key in place of the AWS S3 details.

For a more comprehensive guide on setting up MinIO and using it to simulate S3, refer to this article.

Mailpit

Mailpit is an email testing tool for developers. It acts as both an SMTP server, and provides a web interface to view all captured emails.

You can send your emails to Mailpit SMTP server at localhost:1025 and view them at the Mailpit web UI at http://localhost:8025.

Mailpit

Meilisearch

Meilisearch is an open-source search engine. It's a perfect fit for apps needing to deliver user-friendly, relevant and fast search.

The default config:

  • Port: 7700

Memcached

Memcached is a general-purpose distributed memory-caching system. It is often used to speed up dynamic database-driven websites by caching data and objects in RAM to reduce the number of times an external data source (such as a database or API) must be read.

The default config:

  • Port: 11211

RabbitMQ

RabbitMQ is an open-source message-queueing software also known as a message broker or queue manager.

The default config:

  • Port: 5672

PostgreSQL

PostgreSQL, also known as Postgres, is an object-relational database management system (ORDBMS) with an emphasis on extensibility and standards compliance.

The default config:

  • Host: pgsql
  • Port: 3306
  • Username: vail
  • Password: password

MariaDB

MariaDB is a community-developed, commercially supported fork of the MySQL relational database management system, which provides similar features and interface.

The default config:

  • Host: mariadb
  • Port: 3306
  • Username: vail
  • Password: password

Support

You can show your support by starring this project.

Github Star

Contributing

We welcome any contributions, bug reports, and feature requests. Please see contributing guide for more information.

License

MIT