You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-6Lines changed: 19 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,13 +12,18 @@ Next-Generation scientific mind mapping.
12
12
13
13
You can find a list of shortcuts at [shortcuts.md](shortcuts.md).
14
14
15
+
15
16
## 🌟 Try It Out!
16
17
17
-
There are a couple of ways to try out JabMap. The fastest way to just get a grasp of it is on [github pages](https://jabref.github.io/jabmap/). Note that this will merely allow you to create some nodes, edit and tag them. Saving, Loading and JabRef-related features like BibTeX-Nodes and importing attached PDF-files as nodes won't work unless you are running our version of JabRef's HTTP-Server (see [below](##-🤖-getting-the-server-running) for setup) since the mentioned features rely on it.
18
+
There are a couple of ways to try out JabMap. In any case, you first have to start the HTTP-Server on your machine since Saving, Loading and JabRef-related features like BibTeX-Nodes and importing attached PDF-files as nodes won't work unless you are running JabRef's HTTP-Server (see [below](#-getting-the-server-running) for setup). Afterwards check out [github pages](https://jabref.github.io/jabmap/) where you can try JabMap in your browser!
19
+
20
+
> Note: It's still possible your browser blocks access to the server due to HTTP/HTTPS issues
21
+
> If you see an Error 404 page, this is most likely the cause. Check if the server has started properly or use another browser and try again.
22
+
>
23
+
> For the best experience follow the steps below on how to try JabMap.
18
24
19
-
>Note: It's still possible your browser blocks access to the server due to HTTP/HTTPS issues, for the best experience follow the steps below on how to try JabMap running it locally.
20
25
21
-
### Running it locally
26
+
### Quick-Start-Guide
22
27
23
28
The following commands get the code in place and start JabRef and JabMap with the help of a handy wrapper tool called [gg.cmd](https://github.com/eirikb/gg).
24
29
A little terminal magic is required, but don't worry, we have the commands all laid out for you!
@@ -31,10 +36,15 @@ A little terminal magic is required, but don't worry, we have the commands all l
@@ -43,7 +53,7 @@ A little terminal magic is required, but don't worry, we have the commands all l
43
53
6. Install dependencies: `sh gg.cmd npm install`
44
54
7. Build: `sh ./gg.cmd npm run build`
45
55
8. Run: `sh ./gg.cmd npm run preview`
46
-
9. Now one can open http://localhost:4173/ and open a library with the corresponding map.
56
+
9. Now you can open http://localhost:4173/ and open a library with the corresponding map.
47
57
48
58
49
59
## 🤖 Getting the server running
@@ -52,12 +62,15 @@ As mentioned above, several features are handled by JabRef's HTTP server. Curren
52
62
53
63
### using gg.cmd
54
64
55
-
If you followed the steps (**running-it-locally**) above, instead of steps 6. - 9. you can simply do the following to start the server without JabRef's GUI:
65
+
If you followed the setup for JabRef [above](#jabref), instead of steps 6. - 9. you can simply do the following to start the server without JabRef's GUI:
56
66
57
67
```
58
68
sh ./gg.cmd jbang .jbang/JabSrvLauncher.java
59
69
```
60
70
71
+
> Note: this is **not** recommended for trying out JabMap for the first time since it will not allow you to create a new library. Use this only if you already used JabRef before :)
72
+
73
+
61
74
### Starting it from an IDE
62
75
63
76
1. If you haven't already, clone our [JabRef's fork repository](https://github.com/iloveskittles82/jabref) (_Note: It is recommended to complete this step of_[_JabRef's setup guide_](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-12-build.html)).
0 commit comments