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
You can find a list of shortcuts at [shortcuts.md](shortcuts.md).
14
14
15
-
16
15
## 🌟 Try It Out!
17
16
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!
17
+
1. Launch JabRef
18
+
2. File > Preferences > Check "HTTP Server"
19
+
3. If you don't have any BibTeX files at hand:
20
+
21
+
1. Click on "Create example Library"
22
+
2. Save (Button in the top left or <kbd>Ctrl/Ccmd</kbd> + <kbd>S</kbd>)
19
23
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.
24
+
4. Visit <https://jabref.github.io/jabmap/>
24
25
26
+
Hint: At click on "Save", a `.jmp` file is created next to your `.bib` file.
25
27
26
-
### Quick-Start-Guide
28
+
##Running locally
27
29
28
30
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).
29
31
A little terminal magic is required, but don't worry, we have the commands all laid out for you!
30
32
31
-
#### JabRef:
33
+
#### JabRef
32
34
33
35
1. Go to your git-repositories folder and start a new terminal session
@@ -55,25 +53,23 @@ After setting up JabRef, you can either use [JabMap on GitHub pages](https://jab
55
53
8. Run: `sh ./gg.cmd npm run preview`
56
54
9. Now you can open http://localhost:4173/ and open a library with the corresponding map.
57
55
58
-
59
56
## 🤖 Getting the server running
60
57
61
-
As mentioned above, several features are handled by JabRef's HTTP server. Currently you have to start it manually. Luckily, there are multiple ways to do that:
58
+
Instead of having the JabRef GUI running, you can just run JabRef's HTTP server. There are multiple ways to do that:
62
59
63
-
### using gg.cmd
60
+
### using `gg.cmd`
64
61
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:
62
+
If you followed the setup for JabRef [above](#jabref), instead of steps 5 and 6 you can simply do the following to start the server without JabRef's GUI:
66
63
67
64
```
68
65
sh ./gg.cmd jbang .jbang/JabSrvLauncher.java
69
66
```
70
67
71
68
> 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
69
73
-
74
70
### Starting it from an IDE
75
71
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)).
72
+
1. If you haven't already, clone our JabRef and follow [JabRef's setup guide](https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/).
77
73
2. Afterwards, open it in editor of your choice (_IDEA works well for this_) and locate the `jabsrv/src/test/rest-api.http` file.
78
74
3. Follow the steps described at the top of the file to start the server.
79
75
@@ -83,14 +79,14 @@ _Alternatively_ you can do the following:
83
79
84
80
More about starting the server in [JabRef's server documentation](https://devdocs.jabref.org/code-howtos/http-server.html)
85
81
86
-
87
82
## 💾 Install by building the application
88
83
89
84
Now that you've tried it, here is how to build and install it. We hope to provide a downloadable installer in the future, but for now you have to build the app yourself.
90
85
This section is more targeted towards
91
86
Currently, there is no production build available for download so you have to build it yourself :3
92
87
93
88
### Basic Setup
89
+
94
90
Firstly ensure you have `nvm` (_Node version manager_) and `Node.js` installed:
95
91
96
92
1. Open terminal (_you may have to run it with administrator permissions_)
@@ -106,7 +102,9 @@ Firstly ensure you have `nvm` (_Node version manager_) and `Node.js` installed:
106
102
After you ensured the basic setup is complete, clone this repository onto your machine and open a terminal session at the project root.
107
103
108
104
### Building
105
+
109
106
Now you should be able to run the following commands:
107
+
110
108
1.`npm install` - this will install / update all necessary packages in a `./node_modules` directory.
111
109
2.`npm run bundle` - this will bundle the project into the `./electron-dist` directory.
112
110
@@ -121,6 +119,7 @@ _More about this workaround in [this issue](https://github.com/electron-userland
121
119
On Linux and Mac, there is a bug with npm and optional dependencies (See [this issue](https://github.com/npm/cli/issues/4828). Should you encounter this bug after running `npm install`, remove the `package-lock.json` file and `node-modules` directory and run `npm i`. Then, simply continue with step 2.
122
120
123
121
### Starting
122
+
124
123
After a successful build you can finally start the app located at `./electron-dist/win-unpacked/JabMap.exe`.
125
124
126
125
_Optionally you can install it by opening_`./electron-dist/JabMap Setup 1.0.0.exe`
0 commit comments