Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dyslab/vue-neuron

Static Website built by Vue / Vite, deployed on Netlify
https://github.com/dyslab/vue-neuron

static-website vue3

Last synced: 24 days ago
JSON representation

Static Website built by Vue / Vite, deployed on Netlify

Awesome Lists containing this project

README

        

# vue-neuron: Static site powered by VUE / Vite + Netlify

[![Netlify Status](https://api.netlify.com/api/v1/badges/f63cda47-090d-41bf-aae2-56ef82e9896b/deploy-status)](https://app.netlify.com/sites/vue-neuron/deploys)

## Demo

Demo website published to: [https://vue-neuron.netlify.app](https://vue-neuron.netlify.app)

## Project Setup, Development & Deployment

### Setup

```sh
npm install netlify-cli -g

npm install
```

### Development

```sh
netlify dev
```

### Build for Production

```sh
netlify build
```

### Deploy to Netlify (after `netlify build`)

Automatically CI deployment with Github repository is **Stopped** (See document ["Stop or activate builds"](https://docs.netlify.com/configure-builds/stop-or-activate-builds/)). Manually deployment by the netlify-cli command lines below.

```bash
# Deploy to Netlify as draft
netlify deploy

# Deploy to Netlify as production
netlify deploy --prod
```

## Project Contents

### Mail Notification by Netlify Functions / Edge Functions / Email Integration Plugin / Form

#### Netlify Functions

- [mailgun-sendmail](netlify/functions/mailgun-sendmail/) Send mail via [Netlify Email Integration Plugin](#netlify-email-integration-plugin) (Mail Service Provider: [Mailgun](https://app.mailgun.com/mg/dashboard))

- [aliyun-dm-sendmail](netlify/functions/aliyun-dm-sendmail/) Send mail via [Aliyun Direct Mail Service](https://dm.console.aliyun.com/#/directmail/Home/)

> **Deployment Notes**: Compressing whole directory and files of *netlify/functions/aliyun-dm-sendmail/* recursively to a **ZIP** archive file. Then manually deploy to Netlify server by command line `netlify deploy --prod`.

#### Netlify Email Integration Plugin

- [Email Integration Configuration (Mail Service Provider: Mailgun)](https://app.netlify.com/sites/vue-neuron/integrations/emails), See Document [Email Integration](https://docs.netlify.com/integrations/email-integration/)

#### Netlify Edge Functions

- [aliyun-dm-sendmail-edge](netlify/edge-functions/aliyun-dm-sendmail-edge.js)

Netlify Docs refer to: [Function](https://docs.netlify.com/functions/overview/), [Edge Functions](https://docs.netlify.com/edge-functions/overview/), [Email Integration](https://docs.netlify.com/integrations/email-integration/)

#### Netlify Form

- HTML form page in iframe window: [public/enquiry-form/sample.html](public/enquiry-form/sample.html) showed in [PoolEnquiry.vue](src/PoolEnquiry.vue)

## Appendix

### Netlify One-Click Deployment for Github public repository

```md
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/dyslab/vue-neuron)
```

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/dyslab/vue-neuron)

### Netlify Function CLI

```sh
# Netlify functions help
netlify help functions

# Create new function
netlify functions:create

# List functions
netlify functions:list

# Start Netlify development environment
netlify dev

# Netlify function test via browser
http://localhost:8888/.netlify/functions/aliyun-dm-sendmail
# Or, Test 'GET' methon by CLI
netlify functions:invoke --port 8888 aliyun-dm-sendmail
# Test 'POST' methon with a json file body
netlify functions:invoke -p assets/example.json --port 8888 aliyun-dm-sendmail

# Alternatively, solely start Netlify functions serve
netlify functions:serve # All above command line argument '--port' set to '9999' instead
```

### Vite Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).