eb73a7cf37
* included info about dark mode feature for those with visual accessiblity
59 lines
817 B
Markdown
59 lines
817 B
Markdown
# Mitra Web
|
|
|
|
Default frontend for [Mitra](https://codeberg.org/silverpill/mitra). Mitra includes a dark mode feature for visual accessibility.
|
|
|
|
<img width="650" src="screenshot.png" alt="screenshot">
|
|
|
|
## Requirements
|
|
|
|
- node 12 or 14
|
|
- npm 7+
|
|
|
|
## Project setup
|
|
|
|
```
|
|
npm install --no-save
|
|
npx allow-scripts
|
|
```
|
|
|
|
### Compile and minify for production
|
|
|
|
Set backend URL:
|
|
|
|
```
|
|
echo "VUE_APP_BACKEND_URL=https://mydomain.tld" > .env.local
|
|
```
|
|
|
|
Or un-set it if both frontend and backend will run on the same URL:
|
|
|
|
```
|
|
echo "VUE_APP_BACKEND_URL=" > .env.local
|
|
```
|
|
|
|
Compile:
|
|
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
This will produce a static website in the `/dist` directory.
|
|
|
|
## Development
|
|
|
|
### Compiles and hot-reloads for development
|
|
|
|
```
|
|
npm start
|
|
```
|
|
|
|
### Run your unit tests
|
|
|
|
```
|
|
npm run test
|
|
```
|
|
|
|
### Lint files
|
|
|
|
```
|
|
npm run lint
|
|
```
|