V/Vm-ifier

A string randomizer inspired by V/Vm HelpAphexTwin4.0 that creates random songlists or transforms any input.

Report Bug or · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Serve
4. Build
   • Trunk
   • Docker
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

V/Vm-ifier is a string randomizer inspired by V/Vm and the HelpAphexTwin4.0 album, allowing users to generate unique song lists by selecting parameters such as the number of songs and word counts. It outputs these lists with the distinctive aesthetic of the HelpAphexTwin4.0 album and includes a versatile string transformer for manipulating any text input. V/Vm-ifier blends customizable options with random creativity.

(back to top)

Built With

This project is built with the following technologies:

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• Rustup and Cargo installed on your local machine
• Git installed on your local machine

Installation

1. Install the WebAssembly target: rustup target add wasm32-unknown-unknown
2. Install Trunk by running cargo install --locked trunk
3. Clone the repository to your local machine using the following command: git clone https://github.com/thadah/v_vmifier.git
4. Navigate to the project directory: cd v_vmifier

(back to top)

Serve

Run the following command to start the development server: trunk serve --open.

The server will be running at http://localhost:8082, but this can be changed in the Trunk.toml file:

# Configuration for the development server
[serve]
port = 8082

(back to top)

Build

This service can be built either with Trunk or Docker and can be run in either development mode or production mode.

Trunk

Run the following command to build the project: trunk build --release --out-dir dist

Docker

Dockerfile

To build using the Dockerfile, run the following command: docker build -t v_vmifier .

You can then run it with the following command: docker run -p 80:80 v_vmifier

Docker Compose

To build using the Docker Compose file, run the following command: docker compose build

You can then run it with the following command: docker compose up

(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)

License

Distributed under the European Union Public License v1.2. See LICENSE for more information.

(back to top)

Contact

Thadah D. Denyse - thadahdenyse@protonmail.com Aitor Astorga Saez de Vicuña - a.astorga.sdv@protonmail.com

Project Link: https://github.com/thadah/v_vmifier

(back to top)

Acknowledgments

Many thanks to those who contributed to this project:

• Aderlyn: For the original idea 💜
• Aitor Astorga: For creating the frontend for the album based on the original V/Vm HelpAphexTwin4.0 ❤️
• Leyland James Kirby: For the music and the album 🎵

Thanks to this awesome projects for their contributions:

• Trunk
• Img Shields
• markdown-badges

(back to top)