11# Macrostrat's map interface
22
3- Macrostrat's map interface is web portal to a geologic model of the Earth's crust.
3+ Macrostrat's map interface is web portal to a geologic model of the Earth's
4+ crust.
45
5- Version 5 of the application transitions to using [ Vite] ( https://vitejs.dev/ ) for bundling and [ Vike] ( https://vike.dev/ )
6- for server-side rendering. We are working on updating this version for performance and stability.
6+ Version 5 of the application transitions to using [ Vite] ( https://vitejs.dev/ )
7+ for bundling and [ Vike] ( https://vike.dev/ ) for server-side rendering. We are
8+ working on updating this version for performance and stability.
79
810## Installation for local development
911
10121 . Clone the repository
11132 . Pull down submodules (` git submodule update --init --recursive ` )
12- 3 . Create and populate a ` .env ` file with the appropriate environment variables (See [
13- ` .env.example ` ] ( https://github.com/UW-Macrostrat/web/blob/main/.env.example ) for more information.)
14- 4 . Verify that you have access to recent versions of Node.js and the Yarn package manager ( ` node >= 16.0.0 ` and
15- ` yarn >= 4.0.0 ` ; run ` node -v ` and ` yarn -v ` to check)
14+ 3 . Create and populate a ` .env ` file with the appropriate environment variables
15+ (See
16+ [ ` .env.example ` ] ( https://github.com/UW-Macrostrat/web/blob/main/.env.example )
17+ for more information.)
18+ 4 . Verify that you have access to recent versions of Node.js and the Yarn
19+ package manager ( ` node >= 16.0.0 ` and ` yarn >= 4.0.0 ` ; run ` node -v ` and
20+ ` yarn -v ` to check)
16215 . Run ` yarn install ` to update packages
17- 6 . Start the live-reloading development server with ` yarn run dev ` . The server will be available at
18- ` http://localhost:3000 ` by default.
22+ 6 . Start the live-reloading development server with ` yarn run dev ` . The server
23+ will be available at ` http://localhost:3000 ` by default.
1924
2025## Contributing
2126
22- Please see the [ Contributing guide] ( ./CONTRIBUTING.md ) for information on how to contribute to this codebase.
27+ Please see the [ Contributing guide] ( ./CONTRIBUTING.md ) for information on how to
28+ contribute to this codebase.
2329
2430## Packaging
2531
2632### Running locally with Docker
2733
28- Spins up a instance of the website for development on the same node image used for prod.
34+ Spins up a instance of the website for development on the same node image used
35+ for prod.
2936
3037``` bash
3138docker run -it -p 3010:3000 -v $( pwd) :/app -w /app node:20 git config --global --add safe.directory /app && yarn run dev
@@ -57,15 +64,16 @@ To deploy to kubernetes there is two steps.
5764
58652 . Update the deployment in Kubernetes
5966
60- You do this by updating the image tag here to whatever you tagged
61- above: https://github.com/UW-Macrostrat/tiger-macrostrat-config/blob/main/manifests/development/web/deployment-patch.yaml
67+ You do this by updating the image tag here to whatever you tagged above:
68+ https://github.com/UW-Macrostrat/tiger-macrostrat-config/blob/main/manifests/development/web/deployment-patch.yaml
6269
6370## Testing authentication on localhost
6471
65- If you are developing locally and need to test authentication, you can
66- use a browser extension like ** CookieSync** to automatically pull cookies from the production or development
67- site into your local environment. This will allow you to use the same session
68- information locally. The cookie that must be copied is called ` access_token ` .
72+ If you are developing locally and need to test authentication, you can use a
73+ browser extension like ** CookieSync** to automatically pull cookies from the
74+ production or development site into your local environment. This will allow you
75+ to use the same session information locally. The cookie that must be copied is
76+ called ` access_token ` .
6977
7078We will eventually build an enhanced authentication service to allow for easier
7179local development.
@@ -74,4 +82,3 @@ local development.
7482MACROSTRAT_API_PROXY_DOMAIN=" https://dev2.macrostrat.org"
7583VITE_MACROSTRAT_API_DOMAIN=" http://localhost:3000"
7684```
77-
0 commit comments