Skip to content

Commit

Permalink
init
Browse files Browse the repository at this point in the history
  • Loading branch information
EcoFreshKase committed Jan 10, 2024
0 parents commit 4363687
Show file tree
Hide file tree
Showing 23 changed files with 19,787 additions and 0 deletions.
26 changes: 26 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

/.vscode

# testing
/coverage

# production
/build
/dist

# misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Oversynctero

Oversynctero is a Chrome Plugin to automatically synchronies a .bib file in your Overleaf project with your Zotero Online Storage for free.

# How to User Oversynctero

If you have a problem with the setup please check the FAQ.

## Setup

- make sure the collection you want to synchronize is in your Zotero online storage
- Create an Zotero API Key
- get your Zotero User Id
- make sure you have a file in your Overleaf project with the .bib extension

### Install Oversynctero

1. download the latest release of Oversynctero
2. Go to your Chrome Extension Settings Page
3. Make sure developer mode is activated
4. Go to [chrome://extensions/](chrome://extensions/)
5. Click "Load unpacked"
6. Select the directory you downloaded

If you press the extensions button in Chrome you should see the Oversynctero extension.

### Use Oversynctero

1. Go to your [Overleaf](https://www.overleaf.com/project) Project
2. Open Oversynctero in the extensions menu
3. Go to settings
4. Now enter your Zotero User Id in User_id and your Zotero API Key in API_key
5. You might need to change the API_ENDPOINT in some special cases but for most cases you can ignore the setting
6. Go back to Home
7. Select your Zotero Connection to synchronize in Overleaf
8. Press "IMPORT RESFS.BIB"
9. Your Zotero Collection should now be copied into your .bib file (might take a second or two)
10. Continue working on your Overleaf project

# FAQ

## How to create an Zotero API Key?

1. Go to your [Zotero API Settings](https://www.zotero.org/settings/keys)
2. Click "Create new private key"
3. Give the key a name to keep everything organized for yourself
4. Press "Save Key"
5. The key should now be created and you should see the API Key

## Where to find Zotero User Id?

1. Go to your [Zotero API Settings](https://www.zotero.org/settings/keys)
2. You should see a field saying: "Your userID for use in API calls is {yourUserId}"

## How to enable the developer mode in Chrome?

1. Go to your [Chrome Extensions](chrome://extensions/)
2. You should see a switch (top right corner as I'm writing this) saying Developer mode
3. enable the switch

## My Zotero Collection changed but my .bib file didn't change

1. Open Oversynctero in the extensions menu
2. Select your Zotero Collection
3. Press "IMPORT REFS.BIB"
11 changes: 11 additions & 0 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "1.0.0",
"manifest_version": 3,
"name": "Oversynctero",
"description": "Oversynctero is a Chrome Plugin to automatically synchronies a .bib file in your Overleaf project with your Zotero Online Storage for free.",
"action": {
"default_popup": "js/index.html",
"default_title": "Oversynctero"
},
"permissions": ["activeTab", "scripting", "storage"]
}
Loading

0 comments on commit 4363687

Please sign in to comment.