Textwire Documentation

Docs build with Docusaurus.

Contribute

NPM Commands

Install Dependencies

npm install

Watch File Changes

npm start

Navigate to http://localhost:3000 to see your documentation.

With Container Engine

Note

If you use 🐳 Docker instead of 🦦 Podman, just replace podman-compose with docker compose, and podman with docker in code examples below.

Build an Image

To build an image, navigate to the root of the project and run this command:

podman-compose build

Copy node_modules Locally

If you need to copy node_modules directory from the container to your local machine, run this command:

podman cp textwire-docs:/app/node_modules .

Note

node_modules is excluded from using volume in compose.yml file, that's why you need to copy it manually. It's done to prevent your local modules to be copied to Linux container, since it can create incompatibility issues between operating systems if you don't use Linux.

Run the Container

To run a container, navigate to the root of the project and run this command:

podman-compose up -d

You can visit http://localhost:3000 to see your documentation. Your files will be auto-compiled to plain JavaScript as you change them.

Enter the Container

To enter inside of the container, run this command:

podman-compose exec app sh

You'll be able to run NPM commands inside of the container.

Warning

You don't need to run npm start because it's already running after you created a container.

Delete the Container

After you are done working on a project, you can cleanup by stopping and removing all the running containers for this project.

podman-compose down