Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/shyim/tanjun-website

Last synced: 10 days ago
JSON representation

Host: GitHub
URL: https://github.com/shyim/tanjun-website
Owner: shyim
License: mit
Created: 2024-10-14T21:09:18.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2024-10-27T11:44:59.000Z (24 days ago)
Last Synced: 2024-10-27T13:12:19.117Z (24 days ago)
Language: Vue
Size: 6.97 MB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# 🚀 Tanjun Website

[![Vue.js](https://img.shields.io/badge/Vue.js-3.5-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white)](https://vuejs.org/)
[![Vite](https://img.shields.io/badge/Vite-5.4-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
[![TailwindCSS](https://img.shields.io/badge/TailwindCSS-3.4-38B2AC?style=for-the-badge&logo=tailwind-css&logoColor=white)](https://tailwindcss.com/)

Welcome to the Tanjun Website repository! This project serves as the official website for [Tanjun](https://github.com/shyim/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:

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

2. Install dependencies:

```bash
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:

```bash
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](LICENSE) file for details.

## 🙏 Acknowledgements

- [Vue.js](https://vuejs.org/)
- [Vite](https://vitejs.dev/)
- [TailwindCSS](https://tailwindcss.com/)
- [VueUse](https://vueuse.org/)
- [Asciinema Player](https://github.com/asciinema/asciinema-player)

---

Made with ❤️ by Liam Robinson