mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-10-01 11:28:11 +08:00
Refactor developer convenience scripts (#1377)
* Cleanup the backend-dev convenience method * Add the frontend_dev convenience method frontend_dev is a soup-to-nuts convenience method for setting up the FE development environment with node running a the client code on port 3000 with the a separate cellxgene package serving the API over port 5005 in the background. The script can be run from Finder. * Update the developer scripts documentation * Remove the 'test' make target in the client Makefile Rationale: * Given how long the smoke tests take to run, it is unlikely that developers will want to run all tests together. * It is unlikely that developers will have set up the backend server properly for the tests to pass. * Available commands should be safe-ish and not lend themselves to confusing errors. * You can still group tests by concatenating them in a make command, as in `make unit-test smoke-test`. * This target isn't used in any of our CI pipelines -- KISS. * Some version of python3... * Minor typos in docs * Respond to feedback from @bkmartinjr * Make adjustments so that DATASET path is predictable * Simplify environment defaults a bit
This commit is contained in:
@@ -4,7 +4,6 @@ ifeq ($(shell uname),Darwin) # is Windows_NT on XP, 2000, 7, Vista, 10...
|
||||
IS_DARWIN := "true"
|
||||
endif
|
||||
|
||||
DATASET := $(if $(DATASET),$(DATASET),../example-dataset/pbmc3k.h5ad)
|
||||
ANNOTATIONS := $(if $(ANNOTATIONS),$(ANNOTATIONS),../server/test/test_datasets/pbmc3k-annotations.csv)
|
||||
ANNOTATIONS_FILENAME := $(shell basename $(ANNOTATIONS))
|
||||
|
||||
@@ -38,36 +37,10 @@ lint-diff:
|
||||
|
||||
|
||||
# Development convenience methods
|
||||
|
||||
.PHONY: server-requirements
|
||||
server-requirements:
|
||||
virtualenv -p python3 ../venv
|
||||
source ../venv/bin/activate && \
|
||||
pip install -r ../server/requirements-dev.txt && \
|
||||
yes | pip uninstall cellxgene || true && \
|
||||
pip install -e ..
|
||||
|
||||
.PHONY: start-frontend
|
||||
start-frontend:
|
||||
node server/development.js
|
||||
|
||||
.PHONY: start-server
|
||||
start-server:
|
||||
cellxgene launch -p $(CXG_SERVER_PORT) $(CXG_OPTIONS) $(DATASET)
|
||||
|
||||
.PHONY: backend-dev
|
||||
backend-dev: server-requirements
|
||||
source ../venv/bin/activate && CXG_OPTIONS='--debug' $(MAKE) start-server
|
||||
|
||||
.PHONY: backend-dev-anno-ontology
|
||||
backend-dev-anno-ontology: server-requirements
|
||||
CXG_OPTIONS='--experimental-annotations-ontology --debug' \
|
||||
$(MAKE) backend-dev
|
||||
|
||||
.PHONY: test
|
||||
test:
|
||||
node node_modules/jest/bin/jest.js
|
||||
|
||||
.PHONY: e2e
|
||||
e2e:
|
||||
node node_modules/jest/bin/jest.js \
|
||||
|
||||
Reference in New Issue
Block a user