Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yagiziskirik/research-box
Research note-taking application built with Next.js
https://github.com/yagiziskirik/research-box
cockroachdb next-auth nextjs prisma react reactjs tailwindcss typescript vercel
Last synced: 6 days ago
JSON representation
Research note-taking application built with Next.js
- Host: GitHub
- URL: https://github.com/yagiziskirik/research-box
- Owner: yagiziskirik
- License: mit
- Created: 2023-06-03T00:56:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-31T14:05:43.000Z (8 months ago)
- Last Synced: 2024-03-31T15:23:09.244Z (8 months ago)
- Topics: cockroachdb, next-auth, nextjs, prisma, react, reactjs, tailwindcss, typescript, vercel
- Language: TypeScript
- Homepage: https://research-box.vercel.app
- Size: 1020 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# ResearchBox
  
Unlock the power of knowledge organization with ResearchBox, your comprehensive research repository.
## Features
- 📓 Easy-to-use markdown note taking
- 💾 Autosave feature
- 👔 Professional blog-like appearence
- 💡 Simple, yet effective
- 💬 ChatGPT prompt generator from YouTube video transcriptions
- 🏷️ Efficient tag system
- 👤 No need to create an account for shared researches
## Usage
## Getting started
This project is not a replacement for big companies like Medium. It is not a blog, but just a simple note-taking app which is primarily developed to summarise YouTube videos, taking notes on some topics and sharing them later on.
Since the project is based on Next.js arcitecture, even though it has dynamic data fetching from database, it is still blazingly fast. I developed it as semi progressive web app, which means you can use it on your phone like an actual program if you have internet connection.
> For the curious ones, the website itself has a perfect score on every category in Lighthouse tests. 
## Creating an account
You can go to the website following [this link](https://research-box.vercel.app). If you have a Github account (which I believe you do), you already have a ResearchBox account. Simply press `Login` button anywhere on screen to start using ResearchBox.
## Basics
All we need to do is to add a new draft to get started. To do that, first we head to the `All Work` page.
### All Work Page
Since we don't have any work here yet, we can create a new one with the `Add New` button. After pressing the button, we will be presented with research editing screen.
Let's explain every element.
1. Header of the research.
2. Short explanation will be shown in all the researches and `All Work` pages.
3. Tag container (press enter to add new **unique** tag).
4. Is published switch. If not turned on, only you can see the research even if you share it.
5. Markdown edit window.
6. ChatGPT Prompt Generator.
> It uses your clipboard to _transcribe_ a video and give you copy-ready ChatGPT prompt to get the summary of any YouTube video. Please make sure the last item in your clipboard is the YouTube video link.
7. Save button, which saves the changes or wait for 5 seconds after the last change to autosave feature to kick in.
Once you finish adding a research, your research will be added to the `All Work` page. As you can see, new buttons will come up:
The (1) is the delete button to remove any researches you want. And the (2) is the indicator that you can track whether the research is published. Remember that you cannot go to the published researches from this page. All other pages will show the released version of the research.
### Tags Page
It is very straight forward. You can see the tags you created, and checkout the articles have that tag.
### Researches Page
You can see your published researches and `preview` them here.
### Index Page
Once you logged in, you can see your last 5 published researches here.
### Article
Everything under the URL of `https://research-box.vercel.app/posts/POST_ID` directory counts as an article. If you share that URL and your research is published, everyone who follows this URL can see the research without a need to login.
## Accessibility
All pages are entirely supports light and dark mode settings of your device. Also, pages are responsive in order to be opened in all devices.
### Mobile Device Support
By clicking the `share` button on your device, you can add ResearchBox to your home screen on your mobile device. It looks and works like a mobile app.
After adding the ResearchBox to the home screen, as you can see, it works like a different app (not a Safari tab anymore).
