diff --git a/.gitignore b/.gitignore index 8112b32..72db707 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,6 @@ cypress/downloads cypress/screenshots cypress/videos -# Ignore all dist files except for the CustomTourBuilder +# Ignore all dist files except for the MyMuseumTourBuilder dist/* -!dist/CustomTourBuilder.js +!dist/MyMuseumTourBuilder.js diff --git a/README.md b/README.md index 005dec6..6c3c993 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ ![Art Institute of Chicago](https://raw.githubusercontent.com/Art-Institute-of-Chicago/template/master/aic-logo.gif) -# Custom Tours ![Build status badge](https://github.com/art-institute-of-chicago/custom-tours/actions/workflows/build.yml/badge.svg) +# My Museum Tour ![Build status badge](https://github.com/art-institute-of-chicago/my-museum-tour/actions/workflows/build.yml/badge.svg) ## Summary of the project -This React app drives the custom tours builder on the main [artic.edu website](https://artic.edu/custom-tours). It provided an interactive client-side interface for users to create custom tours. +This React app drives the My Museum Tour builder on the main [artic.edu website](https://artic.edu/my-museum-tour). It provided an interactive client-side interface for users to create a My Museum Tour. ## Features - Uses the API from [artic.edu](https://artic.edu) to: - Search artworks - - `POST` data to the `custom-tours` endpoint + - `POST` data to the `my-museum-tour` endpoint - Cypress component testing and integration testing - Included as part of the Github Actions workflow @@ -28,9 +28,9 @@ It's decoupled from [artic.edu](https://github.com/art-institute-of-chicago/arti ## Configuration -The `` React component can take in two `props`. +The `` React component can take in two `props`. -- `apiSaveEndpoint` (optional) - which should be the path to the `custom-tours` save endpoint. If not provided it will default to `/api/v1/custom-tours` +- `apiSaveEndpoint` (optional) - which should be the path to the `my-museum-tour` save endpoint. If not provided it will default to `/api/v1/my-museum-tour` - `heroImageId` (optional) - which should be a string forming part of a IIIF image identifier that will be concatenated into a IIIF URL. If not provided there will be no hero image rendered on the customization screen. @@ -75,7 +75,7 @@ A full list of thse scripts is available in [`package.json`](package.json), or b npm run dev - Watches files in the src directory for changes and serves a preview at https://localhost:43110 with hot module replacement. You can edit the index.html file to update the rendering of this preview (e.g. update the props in CustomToursBuilder) + Watches files in the src directory for changes and serves a preview at https://localhost:43110 with hot module replacement. You can edit the index.html file to update the rendering of this preview (e.g. update the props in MyMuseumTourBuilder) npm run build @@ -142,31 +142,31 @@ The expectation is that the code generated by this project will live within [art ```json { - "custom-tour-builder": "git+ssh://git@github.com/art-institute-of-chicago/custom-tours.git#main", + "my-museum-tour-builder": "git+ssh://git@github.com/art-institute-of-chicago/my-museum-tour.git#main", } ``` > [!NOTE]
-> The fragment (i.e. "#main") of the url shown above refers to the branch. There might be some instances (such as developing a new feature) where you'd like to reference a different branch, which can be achieved by updating this to the corresponding branch and running `npm i custom-tour-builder`. You will need to run this command whenever updates are made to the branch shown here, as the `package-lock.json` stores references to specific commits +> The fragment (i.e. "#main") of the url shown above refers to the branch. There might be some instances (such as developing a new feature) where you'd like to reference a different branch, which can be achieved by updating this to the corresponding branch and running `npm i my-museum-tour-builder`. You will need to run this command whenever updates are made to the branch shown here, as the `package-lock.json` stores references to specific commits -2. Run `npm i custom-tour-builder` +2. Run `npm i my-museum-tour-builder` 3. The default export for the primary component of this app can be accessed as you would any other npm package using ESModules: ```js -import CustomTourBuilder from 'custom-tour-builder'; +import MyMuseumTourBuilder from 'my-museum-tour-builder'; ``` 4. Your app is responsible for mounting this component to the DOM using ReactDOM React 16: ```js - ReactDOM.render(, container); + ReactDOM.render(, container); ``` React > 16: ```js -ReactDOM.createRoot(container).render(); +ReactDOM.createRoot(container).render(); ``` @@ -176,10 +176,10 @@ We encourage your contributions. Please fork this repository and make your chang ```bash # Clone the repo to your computer -git clone git@github.com:art-institute-of-chicago/custom-tours.git +git clone git@github.com:art-institute-of-chicago/my-museum-tour.git # Enter the folder that was created by the clone -cd custom-tours +cd my-museum-tour # Start a feature branch git checkout -b feature/good-short-description diff --git a/dist/CustomTourBuilder.js b/dist/MyMuseumTourBuilder.js similarity index 99% rename from dist/CustomTourBuilder.js rename to dist/MyMuseumTourBuilder.js index 466ea5d..473a2de 100644 --- a/dist/CustomTourBuilder.js +++ b/dist/MyMuseumTourBuilder.js @@ -33,7 +33,7 @@ function V(i) { ), [X, Z] = b(l || []), [ee, te] = b(0), [ae, re] = pe( fe, m || [] - ), ie = C(null), ne = C(null), [se, ce] = b([]), le = u || "/api/v1/custom-tours", [oe, me] = b(!1), [ue, de] = b(0), he = O( + ), ie = C(null), ne = C(null), [se, ce] = b([]), le = u || "/api/v1/my-museum-tour", [oe, me] = b(!1), [ue, de] = b(0), he = O( () => ({ objectNote: 255, title: 255, @@ -286,7 +286,7 @@ function Ee() { className: o, type: "button", onClick: () => { - a === 0 ? B.assign("/my-museum-tours") : r(a === 1 ? 0 : 1); + a === 0 ? B.assign("/my-museum-tour") : r(a === 1 ? 0 : 1); } }, /* @__PURE__ */ e.createElement("svg", { className: "icon--arrow", "aria-hidden": "true" }, /* @__PURE__ */ e.createElement("use", { xlinkHref: "#icon--arrow" })), @@ -1332,7 +1332,7 @@ function Ce() { const v = []; a.length || v.push("A tour title"), a.length > h.title && v.push("Tour title must not exceed the character limit"), n || v.push("A valid email address"), m.length > h.description && v.push( "Tour description must not exceed the character limit" - ), o.length < h.items.min && v.push("At least one artwork is required for your tour"), o.length > h.items.max && v.push("Tours must not contain more than 6 artworks"), o.some((x) => { + ), o.length < h.items.min && v.push("At least one artwork is required for your tour"), o.length > h.items.max && v.push("Tour must not contain more than 6 artworks"), o.some((x) => { var R; return ((R = x.objectNote) == null ? void 0 : R.length) > h.objectNote ? (v.push("Notes must not exceed the character limit"), !0) : !1; }), u(v); @@ -1345,7 +1345,7 @@ function Ce() { n ]), g(() => { _ != null && _.id && (window.removeEventListener("beforeunload", E), B.assign( - `/my-museum-tours/${_.id}?tourCreationComplete=true` + `/my-museum-tour/${_.id}?tourCreationComplete=true` )); }, [_, E]), /* @__PURE__ */ e.createElement("div", { className: "aic-ct-validation" }, l.length ? /* @__PURE__ */ e.createElement( "div", @@ -1462,7 +1462,7 @@ const xe = (i) => { }; return g(() => { window.addEventListener("beforeunload", o), document.body.style.overflow = "unset"; - }, []), /* @__PURE__ */ e.createElement("div", { id: "custom-tours-builder", className: "custom-tours" }, /* @__PURE__ */ e.createElement(V, { ...m }, /* @__PURE__ */ e.createElement(Ee, null), /* @__PURE__ */ e.createElement(j, null, /* @__PURE__ */ e.createElement( + }, []), /* @__PURE__ */ e.createElement("div", { id: "my-museum-tour-builder", className: "my-museum-tour" }, /* @__PURE__ */ e.createElement(V, { ...m }, /* @__PURE__ */ e.createElement(Ee, null), /* @__PURE__ */ e.createElement(j, null, /* @__PURE__ */ e.createElement( L, { id: 0, diff --git a/index.html b/index.html index 111563e..7d77126 100644 --- a/index.html +++ b/index.html @@ -29,14 +29,14 @@