Welcome to the Tanjun Website repository! This project serves as the official website for Tanjun, a powerful Dockerized Deployment Tool designed for simplicity and efficiency.
- 🎨 Modern and responsive design
- ⚡ Lightning-fast performance with Vite
- 🧩 Component-based architecture using Vue.js 3
- 🎭 Smooth animations with VueUse Motion
- 📱 Mobile-friendly layout
- 🎥 Interactive terminal demos using Asciinema Player
- Frontend Framework: Vue.js 3
- Build Tool: Vite
- CSS Framework: TailwindCSS
- Animation: VueUse Motion
- Terminal Player: Asciinema Player
- Linting: ESLint
- Code Formatting: Prettier
- Node.js (v14 or later)
- npm or yarn
-
Clone the repository:
git clone /~https://github.com/shyim/tanjun-website.git cd tanjun-website
-
Install dependencies:
npm install # or yarn install
-
Set up environment variables: Create a
.env
file in the root directory and add the following variables:VITE_APP_NAME="" VITE_APP_TITLE="" VITE_APP_URL="" VITE_REPO_URL=""
Fill in the values according to your project configuration.
-
Start the development server:
npm run dev # or yarn dev
-
Open your browser and visit
http://localhost:5173
The project uses the following environment variables:
VITE_APP_NAME
: The name of your applicationVITE_APP_TITLE
: The title of your application (used in the browser tab)VITE_APP_URL
: The URL where your application is hostedVITE_REPO_URL
: The URL of your GitHub repository
Make sure to set these variables in your .env
file or in your deployment environment.
npm run dev
- Start the development servernpm run build
- Build the project for productionnpm run preview
- Preview the production buildnpm run lint
- Lint the codebasenpm run format
- Format the codebase
We welcome contributions to the Tanjun Website! Please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name
- Make your changes and commit them:
git commit -m 'Add some feature'
- Push to the branch:
git push origin feature/your-feature-name
- Submit a pull request
This project is licensed under the MIT License - see the LICENSE file for details.
Made with ❤️ by Liam Robinson