https://github.com/therealpad/vueapplication

Web application template using vuejs and server side rendering
https://github.com/therealpad/vueapplication

e2e express makefile nightwatch proxy sass server-side-rendering ssr typescript unit-testing vite vue

Last synced: 9 months ago
JSON representation

Web application template using vuejs and server side rendering

• Host: GitHub
• URL: https://github.com/therealpad/vueapplication
• Owner: TheRealPad
• Created: 2024-08-21T12:33:33.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-01-09T11:54:04.000Z (11 months ago)
• Last Synced: 2025-01-09T12:44:13.081Z (11 months ago)
• Topics: e2e, express, makefile, nightwatch, proxy, sass, server-side-rendering, ssr, typescript, unit-testing, vite, vue
• Language: TypeScript
• Homepage:
• Size: 587 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
![Vue.js](https://img.shields.io/badge/vuejs-%2335495e.svg?style=for-the-badge&logo=vuedotjs&logoColor=%234FC08D)

![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)

![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white)

![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)

![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)

[![CI - Build and Test](https://github.com/TheRealPad/vueApplication/actions/workflows/ci.yml/badge.svg)](https://github.com/TheRealPad/vueApplication/actions/workflows/ci.yml)

# vue-project

Vue + Vite application using Server Side Rendering (SSR)

## Start the project

### Env

You need to create a .env file to set the environment variables with the following content:

```dotenv

PORT=3000

API_URL=https://example.com

```

### development mode

```bash

yarn dev

```

### production mod

```bash

yarn build:server

yarn build:client

yarn start

```

### docker

Files are contains in ```./config/docker```

The environment variables are directly set inside the docker-compose.{prod | dev}.yml file

```bash

make # start the container for Unix systems

make stop # stop the container for Unix systems

docker-compose -f ./config/docker/docker-compose.dev.yml up --build # start dev

docker-compose -f ./config/docker/docker-compose.prod.yml up --build # start prod

```

## Test the project

### Unit test

```bash

yarn test:unit

```

### En-to-End test

```bash

yarn test:e2e

```

## Features

If you go to ```./src/client/components/themeSwitch``` you can find the toggle swtch from this [tiktok](https://www.tiktok.com/@codewisdom/video/7267317206025800992)