summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHelianthella <git@gumi.ca>2020-12-22 00:06:42 -0500
committerHelianthella <git@gumi.ca>2020-12-22 00:06:47 -0500
commitb90bbeab7c1435518224496821ff3449476c458d (patch)
treee543aefb386a69bbe4b5d9fc73ebfb4c73c9361f /README.md
parentf9c051e61da67b93ed3c9aba3d77bced80e1503e (diff)
downloadwebsite-b90bbeab7c1435518224496821ff3449476c458d.tar.gz
website-b90bbeab7c1435518224496821ff3449476c458d.tar.bz2
website-b90bbeab7c1435518224496821ff3449476c458d.tar.xz
website-b90bbeab7c1435518224496821ff3449476c458d.zip
upgrade to Vue 3, switch to yarn
implies a slight refactor
Diffstat (limited to 'README.md')
-rw-r--r--README.md72
1 files changed, 16 insertions, 56 deletions
diff --git a/README.md b/README.md
index 7abff46..efcf5d9 100644
--- a/README.md
+++ b/README.md
@@ -1,93 +1,53 @@
# themanaworld-website
+
The website of The Mana World, built with Vue and Vue-Cli.
+
## Project setup
```
-npm install
+yarn install
```
-### Customize configuration
-The app can be configured with environment variables. See [Dotenv] for further info.
-
-
-## Building
-
### Compiles and hot-reloads for development
-```sh
-npm run serve
+```
+yarn serve
```
### Compiles and minifies for production
-```sh
-npm run build
```
-
-## Testing
-### Run all tests
-```sh
-npm run test
+yarn build
```
### Lints and fixes files
-```sh
-npm run lint
```
-
-### Run unit tests
-```sh
-npm run test:unit
+yarn lint
```
-### Run accessibility tests
-```sh
-npm run test:accessibility
-```
-
-### Run performance tests
-```sh
-# TODO: implement Lighthouse
-npm run test:speed
-```
-
-### Run security tests
-```sh
-# TODO: implement Wapiti
-npm run test:security
-```
+### Customize configuration
+See [Configuration Reference](https://cli.vuejs.org/config/). The app can also be configured with environment variables. See [Dotenv] for further info.
## Deployment
### Nginx
1. Build in production mode
2. Add a nginx vhost pointing to the `dist` folder as root
+3. Rewrite all requests to index.html within a `location` block:
+```nginx
+ index index.html;
+ try_files $uri $uri/ /index.html;
+```
### [Netlify]
1. Set up a new project
- - Build command: `npm run build`
+ - Build command: `yarn deploy`
- Publish directory: `dist`
### [Render]
1. Set up a new Web Service
- Environment: `Static Site`
- - Build command: `npm run build`
+ - Build command: `yarn deploy`
- Publish directory: `dist`
-### Gitlab Pages
-```yml
-pages: # the job must be named pages
- image: node:latest
- stage: deploy
- script:
- - npm ci
- - npm run build
- - mv public public-vue # GitLab Pages hooks on the public folder
- - mv dist public # rename the dist folder (result of npm run build)
- artifacts:
- paths:
- - public # artifact path must be /public for GitLab Pages to pick it up
- only:
- - master
-```
[Vue]: https://vuejs.org/
[Dotenv]: https://cli.vuejs.org/guide/mode-and-env.html