vortex/README.md

Vortex

Vortex is a simple and fast web application. It is built with Next.js, Tailwind CSS, and Prisma.

Installation

Docker Compose

1. Copy the .env.example file to .env and fill in the environment variables.
2. Copy the docker-compose.yml file to the root of your project.
3. Copy the redis.conf file to the redis folder, and modify the password.

docker-compose up

Optional Steps for umami

1. Copy the docker-compose.umami.yml file to the root of your project.

docker-compose -f docker-compose.umami.yml up

Backup and Restore PostgreSQL

docker exec -t vortex-postgres pg_dump -U postgres --data-only vortex > dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql

cat dump.sql | docker exec -i vortex_postgres psql -U postgres -d vortex

Vercel

Development

Prerequisites

• Node.js >= v20.8.1
• Yarn
• PostgreSQL
• Redis

Getting Started

1. Install the dependencies.

npm install

2. Copy the .env.example file to .env and fill in the environment variables.
3. Start the development server.

npm run dev

License

Vortex is open source software licensed as MIT.

Acknowledgments

• T3 Stack
• Next.js
• NextAuth.js
• Tailwind CSS
• Prisma
• Umami

Tip

Vortex Agent