Update docs

This commit is contained in:
Alfred Melch 2020-01-07 20:03:24 +01:00
parent 1e5b5e9d4d
commit 704e0a62b1
3 changed files with 23 additions and 16 deletions

12
server/README.md Normal file
View File

@ -0,0 +1,12 @@
# Backend for EbermergenTD
## Install
Requirements: python3, python3-venv and pip
## Available scripts
- `make venv`: creates a python virtual environment
- `make install`: installs python dependencies
- `make run`: runs the development server
- `make test`: runs unittests

View File

@ -1,11 +0,0 @@
serve:
./node_modules/.bin/webpack-dev-server --mode development
build:
./node_modules/.bin/webpack --mode production
lint:
./node_modules/.bin/eslint src
format:
./node_modules/.bin/prettier --write src/**/*.js

View File

@ -1,8 +1,14 @@
#Hello there
# Hello there
## Install
Requirements: node and npm
- `npm install`: installs dependencies in node_modules
## Available scripts
- `npm start`: starts a development server (`make` or `make serve`)
- `npm run build`: make a production build (`make build`)
- `npm run lint`: lint js files using eslint (`make lint`)
- `npm run format`: format js files using prettier (`make format`)
- `npm start`: starts a development server
- `npm run build`: make a production build
- `npm run lint`: lint js files using eslint
- `npm run format`: format js files using prettier