From 704e0a62b144d04021c98a1278090a18a8c50535 Mon Sep 17 00:00:00 2001 From: Alfred Melch Date: Tue, 7 Jan 2020 20:03:24 +0100 Subject: [PATCH] Update docs --- server/README.md | 12 ++++++++++++ web/Makefile | 11 ----------- web/README.md | 16 +++++++++++----- 3 files changed, 23 insertions(+), 16 deletions(-) create mode 100644 server/README.md delete mode 100644 web/Makefile diff --git a/server/README.md b/server/README.md new file mode 100644 index 0000000..f1a5774 --- /dev/null +++ b/server/README.md @@ -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 diff --git a/web/Makefile b/web/Makefile deleted file mode 100644 index 866dfde..0000000 --- a/web/Makefile +++ /dev/null @@ -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 \ No newline at end of file diff --git a/web/README.md b/web/README.md index 09ecf9a..d13f950 100644 --- a/web/README.md +++ b/web/README.md @@ -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