🚀 Tanjun Website

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.

🌟 Features

• 🎨 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

🛠️ Tech Stack

• Frontend Framework: Vue.js 3
• Build Tool: Vite
• CSS Framework: TailwindCSS
• Animation: VueUse Motion
• Terminal Player: Asciinema Player
• Linting: ESLint
• Code Formatting: Prettier

🚀 Getting Started

Prerequisites

• Node.js (v14 or later)
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/shyim/tanjun-website.git
   cd tanjun-website

2. Install dependencies:

   npm install
   # or
   yarn install

3. 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.

4. Start the development server:

   npm run dev
   # or
   yarn dev

5. Open your browser and visit http://localhost:5173

🔧 Environment Variables

The project uses the following environment variables:

• VITE_APP_NAME: The name of your application
• VITE_APP_TITLE: The title of your application (used in the browser tab)
• VITE_APP_URL: The URL where your application is hosted
• VITE_REPO_URL: The URL of your GitHub repository

Make sure to set these variables in your .env file or in your deployment environment.

📜 Available Scripts

• npm run dev - Start the development server
• npm run build - Build the project for production
• npm run preview - Preview the production build
• npm run lint - Lint the codebase
• npm run format - Format the codebase

🤝 Contributing

We welcome contributions to the Tanjun Website! Please follow these steps:

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes and commit them: git commit -m 'Add some feature'
4. Push to the branch: git push origin feature/your-feature-name
5. Submit a pull request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgements

• Vue.js
• Vite
• TailwindCSS
• VueUse
• Asciinema Player

---

Made with ❤️ by Liam Robinson