diff options
author | Sebastian <sebasjm@gmail.com> | 2021-02-19 17:00:31 -0300 |
---|---|---|
committer | Sebastian <sebasjm@gmail.com> | 2021-02-19 17:12:00 -0300 |
commit | 6aba8b53ce84c6b723a5c8c31179fd23d132d7c7 (patch) | |
tree | ef0746fd10864cda14ed4d9ac5c1b30364a444a5 /README.md | |
parent | eecd261cef52c4ccebf5eb49f2326aa86e12f0f8 (diff) | |
download | merchant-backoffice-6aba8b53ce84c6b723a5c8c31179fd23d132d7c7.tar.gz merchant-backoffice-6aba8b53ce84c6b723a5c8c31179fd23d132d7c7.tar.bz2 merchant-backoffice-6aba8b53ce84c6b723a5c8c31179fd23d132d7c7.zip |
better readme, updated makefile with more commands, add config context, switch to nodejs 12
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 47 |
1 files changed, 31 insertions, 16 deletions
@@ -4,38 +4,53 @@ Merchant Admin Frontend is a Single Page Application that connect with a running ## System requirements -- Node version: 14.15.0 -- Yarn version: 1.21.1 +- Node: v12.18.4 +- pnpm: 5.17.2 +- make +- python>=3.8 -## Environment +## Compiling from source -This applications use some configuration from the environment, like the location of the Merchant Backend. -Be sure to copy the file `template.env` into `.env` and override with your custom values. -## Installation +Check the requirements and run `./bootstrap` and `./configure` -First run the command `yarn install` to get all the dependencies. -The running `yarn dev` should set the server up and running. -Use the browser to navigate into `http://localhost:8080` +```shell +./bootstrap +./configure +``` + +Then run `make` to install all the nodejs dependencies + +## Running develop + +To run a development server run + +```shell +make dev +``` + +This should start a watch process that will reload the server every time that a file is saved. + +## Building for deploy ## CLI Commands -* `yarn install`: Installs dependencies +* `make compile`: Installs dependencies and compile with typescript -* `yarn dev`: Run a development, HMR server. The application will automatically refresh +* `make dev`: Run a development, HMR server. The application will automatically refresh every time a file is edited -* `yarn build`: Production-ready build into the `./build` directory. Print bundle size +* `make build`: Production-ready build into the `./build` directory. Print bundle size information and compare its with previous build using the `size-plugin.json` file. -* `yarn serve`: Serves the content into `./build` directory, usefull to test the result. +* `make serve`: build and serves the content, usefull to test the result. -* `yarn lint`: Pass TypeScript files using ESLint +* `make lint`: Pass TypeScript files using ESLint -* `yarn test`: Run Jest and Enzyme with +* `make check`: Run Jest and Enzyme with [`enzyme-adapter-preact-pure`](https://github.com/preactjs/enzyme-adapter-preact-pure) for your tests -* `yarn storybook`: Run visual components explorer. Usefull for components design and development +* `make dev-views`: Run visual components explorer. Usefull for components design and development without the need of setting up the whole system. |