From 9450f994d1bc3e0428aa70fa256f91794b1b309c Mon Sep 17 00:00:00 2001 From: thijsheijden <hi@thijsheijden.nl> Date: Thu, 10 Feb 2022 21:01:02 +0100 Subject: [PATCH] feat(README): removed NX readme, added steps to run locally --- README.md | 105 +++++++++++------------------------------------------- 1 file changed, 20 insertions(+), 85 deletions(-) diff --git a/README.md b/README.md index 3d5c769f3..9f79b01a9 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,29 @@ +# GraphPolaris Frontend +## Preparing to Run Locally -# Graphpolaris +Due to the way auth works (using a sameSite cookie), the procedure for running locally is a little different than usual. These steps will only have to be done, after that everything should 'just' work. -This project was generated using [Nx](https://nx.dev). +### MacOS / Linux -<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="450"></p> +1. `sudo vim /etc/hosts` open the hosts file with your prefered text editor as root +2. Add a new row containing `127.0.0.1 local.datastrophe.science.uu.nl`, this will route traffic from `local.datastrophe.science.uu.nl` to `127.0.0.1` +3. `brew install mkcert` install mkcert utility +4. `mkcert -install` generate local CA (certificate authority) +5. Move into the /certs folder at the project root using `cd` +6. `mkcert --key-file local-key.pem --cert-file local-cert.pem local.datastrophe.science.uu.nl` create certificates for local SSL -🔎 **Smart, Fast and Extensible Build System** +### Windows -## Adding capabilities to your workspace +1. Open the `hosts` file under `C:\Windows\System32\drivers\etc` using a text editor, as administrator +2. Add a new row containing `127.0.0.1 local.datastrophe.science.uu.nl`, this will route traffic from `local.datastrophe.science.uu.nl` to `127.0.0.1` +3. Install mkcert using any of the ways described [here](https://github.com/FiloSottile/mkcert#windows) +4. Open an elevated Powershell or CMD session +5. Move into the /certs folder at the project root using `cd` +6. `mkcert --key-file local-key.pem --cert-file local-cert.pem local.datastrophe.science.uu.nl` create certificates for local SSL -Nx supports many plugins which add capabilities for developing different types of applications and different tools. +> No idea if the Windows steps work -These capabilities include generating applications, libraries, etc as well as the devtools to test, and build projects as well. +## Running Locally -Below are our core plugins: - -- [React](https://reactjs.org) - - `npm install --save-dev @nrwl/react` -- Web (no framework frontends) - - `npm install --save-dev @nrwl/web` -- [Angular](https://angular.io) - - `npm install --save-dev @nrwl/angular` -- [Nest](https://nestjs.com) - - `npm install --save-dev @nrwl/nest` -- [Express](https://expressjs.com) - - `npm install --save-dev @nrwl/express` -- [Node](https://nodejs.org) - - `npm install --save-dev @nrwl/node` - -There are also many [community plugins](https://nx.dev/community) you could add. - -## Generate an application - -Run `nx g @nrwl/react:app my-app` to generate an application. - -> You can use any of the plugins above to generate applications as well. - -When using Nx, you can create multiple applications and libraries in the same workspace. - -## Generate a library - -Run `nx g @nrwl/react:lib my-lib` to generate a library. - -> You can also use any of the plugins above to generate libraries as well. - -Libraries are shareable across libraries and applications. They can be imported from `@graphpolaris/mylib`. - -## Development server - -Run `nx serve my-app` for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files. - -## Code scaffolding - -Run `nx g @nrwl/react:component my-component --project=my-app` to generate a new component. - -## Build - -Run `nx build my-app` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build. - -## Running unit tests - -Run `nx test my-app` to execute the unit tests via [Jest](https://jestjs.io). - -Run `nx affected:test` to execute the unit tests affected by a change. - -## Running end-to-end tests - -Run `ng e2e my-app` to execute the end-to-end tests via [Cypress](https://www.cypress.io). - -Run `nx affected:e2e` to execute the end-to-end tests affected by a change. - -## Understand your workspace - -Run `nx graph` to see a diagram of the dependencies of your projects. - -## Further help - -Visit the [Nx Documentation](https://nx.dev) to learn more. - - - -## ☠Nx Cloud - -### Distributed Computation Caching & Distributed Task Execution - -<p style="text-align: center;"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-cloud-card.png"></p> - -Nx Cloud pairs with Nx in order to enable you to build and test code more rapidly, by up to 10 times. Even teams that are new to Nx can connect to Nx Cloud and start saving time instantly. - -Teams using Nx gain the advantage of building full-stack applications with their preferred framework alongside Nx’s advanced code generation and project dependency graph, plus a unified experience for both frontend and backend developers. - -Visit [Nx Cloud](https://nx.app/) to learn more. +To run the application using SSL (with these keys) simply run `nx run web-graphpolaris:dev`, or `yarn nx run web-graphpolaris:dev` if `nx` is not installed globally. This should open a window to `https://local.datastrophe.science.uu.nl:4200/` automatically. -- GitLab