Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release/v2.0 #47

Open
wants to merge 84 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
84 commits
Select commit Hold shift + click to select a range
4abc924
fresh start
danieleguido Nov 8, 2022
c027fad
add axios
danieleguido Nov 9, 2022
5140ca8
create Menu component
danieleguido Nov 9, 2022
6c237ae
Create User.js
danieleguido Nov 9, 2022
3ca19a0
Update RequireAuth.js
danieleguido Nov 9, 2022
7c98379
add token data to the permanent store
danieleguido Nov 9, 2022
1c9bfd5
Update Settings.js
danieleguido Nov 9, 2022
75e54d3
Update Login.js
danieleguido Nov 9, 2022
c451d48
Update miller.js
danieleguido Nov 9, 2022
5536f9f
Delete AuthProvider.js
danieleguido Nov 9, 2022
ce847f7
Update constants.js
danieleguido Nov 9, 2022
344ca9c
add markdown support and downsize to reduce summaries
danieleguido Nov 9, 2022
de3f025
add Story Component
danieleguido Nov 9, 2022
bae23e4
Update translations.json
danieleguido Nov 9, 2022
ccda94d
Update index.scss
danieleguido Nov 9, 2022
b4cad76
update styles for components in Story page
danieleguido Nov 9, 2022
e500016
Update Login.js
danieleguido Nov 9, 2022
da3810c
use 20 column bootstrap grid
danieleguido Nov 9, 2022
a6fe508
add authentication
danieleguido Nov 9, 2022
1db192a
improve language identification
danieleguido Nov 9, 2022
1918bfd
remove duplicate key in store
danieleguido Nov 9, 2022
061e7ce
Create Story.js
danieleguido Nov 9, 2022
5bbba03
Update Stories.js
danieleguido Nov 9, 2022
1a08782
rearrange column
danieleguido Nov 9, 2022
5f6a168
simplify miller provider
danieleguido Nov 9, 2022
b77a16a
Update Story.js
danieleguido Nov 9, 2022
a539d27
fix visual style
danieleguido Nov 9, 2022
86a5125
add CodeMirror
danieleguido Nov 10, 2022
6517f73
add authentication wall for Story component
danieleguido Nov 10, 2022
bc27a60
Update index.scss
danieleguido Nov 10, 2022
8e5488d
add switch to read only current language
danieleguido Nov 10, 2022
05e93f9
add method lang2Field
danieleguido Nov 10, 2022
0dbe261
Create viewport.js
danieleguido Nov 10, 2022
030e716
on error reset token
danieleguido Nov 10, 2022
d290349
Update StoryModuleTypeSwitch.js
danieleguido Nov 10, 2022
bf0c38d
Update StoryModuleText.js
danieleguido Nov 10, 2022
6978a09
Update StoryModule.js
danieleguido Nov 10, 2022
b9678e3
Update ModuleText.js
danieleguido Nov 10, 2022
d591a17
add prettier
danieleguido Nov 21, 2022
758238a
Update translations.json
danieleguido Nov 21, 2022
4c59ca3
add basic doc page
danieleguido Nov 21, 2022
9fd8b68
restyle aside in global layout, add Doc Route
danieleguido Nov 21, 2022
2faac7d
add docItem component and docsFacets to list filters
danieleguido Nov 21, 2022
a612a43
add docuents route to menu
danieleguido Nov 21, 2022
55df0e0
Create params.js
danieleguido Nov 21, 2022
e56cbae
Update Stories.js
danieleguido Nov 21, 2022
012181a
Update index.scss
danieleguido Nov 21, 2022
d879451
add searchfield
danieleguido Nov 21, 2022
e66b0bb
basic visualisation of person schema
danieleguido Nov 21, 2022
12f146a
fix eslint
danieleguido Nov 25, 2022
65ec663
add favicon
danieleguido Nov 25, 2022
23e523a
add react-spring
danieleguido Nov 28, 2022
79dfbde
fix height for the side menu
danieleguido Nov 28, 2022
516f379
eslint
danieleguido Nov 28, 2022
71a396c
creqte sqvings component
danieleguido Nov 28, 2022
9e85531
Update yarn.lock
danieleguido Nov 28, 2022
a0beaca
Update translations.json
danieleguido Nov 28, 2022
75f365a
Update index.scss
danieleguido Nov 28, 2022
5e7de0b
add setMillerDocumentSchemaRootUrl
danieleguido Nov 28, 2022
a617626
use identifier not slug
danieleguido Nov 28, 2022
c15ab74
Update Settings.js
danieleguido Nov 28, 2022
96e200b
Update miller.js
danieleguido Nov 28, 2022
faeca2a
Update Menu.js
danieleguido Nov 28, 2022
cd416a9
Update App.js
danieleguido Nov 30, 2022
dc51fa3
move Doc/DocFacets to Facets
danieleguido Nov 30, 2022
bb79d6c
fix errors message in Login
danieleguido Nov 30, 2022
671b3dd
Update index.scss
danieleguido Nov 30, 2022
aa101b4
save story (at least de "data" part to fix static pages
danieleguido Dec 2, 2022
f8e78c7
update bootstrap and use npm
danieleguido Apr 27, 2023
e019626
add authors routes
danieleguido Apr 27, 2023
431b062
link authorItem to authorRoute
danieleguido Apr 27, 2023
7360707
Update Covers.js
danieleguido Apr 27, 2023
f541259
Create CreateDoc.js
danieleguido Apr 27, 2023
d2f6304
enbrich menu and fix css
danieleguido Apr 27, 2023
beb263c
move main style out of styles folder
danieleguido Apr 27, 2023
d257ce9
add modal status in store
danieleguido Apr 27, 2023
84233a3
Update yarn.lock
danieleguido Apr 27, 2023
87ee8d3
Update translations.json
danieleguido Apr 27, 2023
a850547
Create CreateDoc.css
danieleguido Apr 27, 2023
b19e1cd
Update setupProxy.js
danieleguido Apr 27, 2023
389ff6b
Update StoryItem.js
danieleguido Apr 27, 2023
aaa27f8
add authorRoutes in constants
danieleguido Apr 27, 2023
c653307
add autthors
danieleguido Apr 27, 2023
824c93f
Update index.js
danieleguido Apr 27, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
7 changes: 7 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
build/
node_modules/
internals/generators/
internals/scripts/
package-lock.json
yarn.lock
package.json
8 changes: 8 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"printWidth": 100,
"tabWidth": 2,
"useTabs": false,
"semi": false,
"singleQuote": true,
"trailingComma": "all"
}
12 changes: 6 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ PUBLIC_URL ?=/editor
run-dev:
PUBLIC_URL=${PUBLIC_URL} \
REACT_APP_EDITOR_BASENAME=${PUBLIC_URL} \
REACT_APP_VISUAL_EDITOR_GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD) \
REACT_APP_VISUAL_EDITOR_GIT_REVISION=$(shell git rev-parse --short HEAD) \
yarn start
REACT_APP_GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD) \
REACT_APP_GIT_REVISION=$(shell git rev-parse --short HEAD) \
npm start

run-build:
REACT_APP_VISUAL_EDITOR_GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD) \
REACT_APP_VISUAL_EDITOR_GIT_REVISION=$(shell git rev-parse --short HEAD) \
PUBLIC_URL=/editor yarn build
REACT_APP_GIT_BRANCH=$(shell git rev-parse --abbrev-ref HEAD) \
REACT_APP_GIT_REVISION=$(shell git rev-parse --short HEAD) \
PUBLIC_URL=/editor npm build

build-docker-image:
docker build \
Expand Down
83 changes: 62 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,70 @@
# The VisualEditor
This is the visual companion of Miller for our the digital exibition websites.
# Getting Started with Create React App

Build a specific version for a project is as easy as:
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

- get your project name, e.g. `histjust`
- get the git tag in `master` branch with `git tag`, e.g. `v1.1.4`
- copy `cp .env.example .env` and edit `REACT_APP_MILLER_CLIENT_ID` according to the target Miller instance
- verify the values of `REACT_APP_DOCUMENT_SCHEMA`
- build using `make` and concatenate project name and version number in the `BUILD_TAG`: env variable
## Available Scripts

```
BUILD_TAG=your-visual-editor-v1.1.4 make build-docker-image
```
In the project directory, you can run:

If your project should support Mapbox, jsut add the env variable
REACT_APP_MAPBOX_ACCESS_TOKEN in your `.env` file. If there's a valid value,
the editor "new module" page will display two additional modules, *Module Map* and *Module Text & Map*
### `npm start`

## Local development with setup proxy
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

Instead of using just `PROXY_HOST`, from v1.1.4 onwards we use setupProxy using the http middleware proxy.
If yoiu run using `make run-dev` or `yarn start` a nice setupProxy.log file will appear next to package.json
that would make transparent which Proxy is using.
The page will reload when you make changes.\
You may also see any lint errors in the console.

## Additional Notes
### `npm test`

In the source code we usually refer to the env variable `REACT_APP_EDITOR_BASENAME`.
This is generated from the `PUBLIC_URL` that is not integrated in the react app as such.
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `npm run eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `npm run build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
Loading