schoolcity's Introduction

Jsd School city

Web Framework for JSD School City's level test

Features

flat eslint config
auto router
layout
atomic css by unocss and tailwindcss reset
pinia
auto import and components
vue dev tools

TODO

refine the level page, priority: highest
migrate to nuxt3

Development

This repo requires node >= 18 and use pnpm as the package manager.

It's better recommended to use VSCode as the editor.

git clone this repository
run pnpm i to install dependencies
run pnpm dev to start the development server
run pnpm serve to start the development server with remote
run pnpm build to build the project, the output will be in the dist folder

Deploy

Native (nginx for example)

with proxy pass to nodejs server, this is badly not recommended, but if you want to use it, you can use this config

server {
  listen 80;
  server_name jsd-school-city.com;

  location / {
    proxy_pass http://localhost:3000;
    # Nodejs server, and you should config your nodejs server
    proxy_http_version 1.1;
    proxy_set_header Upgrade $http_upgrade;
    proxy_set_header Connection 'upgrade';
    proxy_set_header Host $host;
    proxy_cache_bypass $http_upgrade;
  }
}

with static files instead of proxy pass

server {
  listen 80;
  server_name example.com;

  location / {
    try_files $uri $uri/ /index.html;
    root /path/to/your/static/files;
    index index.html;
  }
}

with ssl

server {
  listen 80;
  server_name example.com;

  location / {
    return 301 https://$server_name$request_uri;
  }
}

server {
  listen 443 ssl http2;
  server_name example.com;
  server_tokens off;

  ssl_certificate /path/to/your/cert.pem;
  ssl_certificate_key /path/to/your/cert.key;

  ssl_session_timeout 5m;
  ssl_protocols TLSv1.2 TLSv1.3;
  ssl_prefer_server_ciphers on;
  ssl_ciphers #your ciphers mode#;
  ssl_session_cache builtin:1000 shared:SSL:10m;
  ssl_dhparam /usr/local/nginx/conf/ssl/dhparam.pem;

  location / {
    try_files $uri $uri/ /index.html;
    root /path/to/your/static/files;
    index index.html;
  }

  access_log /path/to/your/logs/access.log;
  error_log /path/to/your/logs/error.log;
}