slack-vuesualizer

(β˜… 119)

Display and search your Slack export

  • .dockerignore
  • .env.sample
  • .eslintrc
  • .gitignore
  • .npmrc
  • app.vue
  • docker-compose.dev.yml
  • docker-compose.yml
  • Dockerfile
  • LICENSE
  • nuxt.config.ts
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • renovate.json
  • tailwind.config.ts
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/4350pChris/slack-vuesualizer

Downloads the entire project code from GitHub to your computer.

cd slack-vuesualizer

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker compose up

Builds and starts all defined containers (server, database, etc.) at once, in the background.

docker compose -f docker-compose.dev.yml up

Runs the command against the services defined in the compose file.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

npm run build

Builds optimized production files.

npm run preview

Type this command into your terminal and run it.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation