Skip to content
This repository was archived by the owner on Jun 10, 2022. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Remember is an notetaking application that allows you to take notes by including text, images, videos, links, lists, checkboxes and support for code snippets, file attachments can be expected in the near future.

Remember is built with React, Redux Toolkit and Firebase. Remeber uses firestore to store the user notes and it uses Editor.js library for editing the notes.
Remember is built with React, Redux Toolkit and Firebase. Remember uses firestore to store the user notes and it uses Editor.js library for editing the notes.

Remember uses three pane layout to organize, edit and save your notes. This layout is borrowed from [Bear](https://bear.app) notetaking app

Expand All @@ -27,11 +27,11 @@ Remember uses three pane layout to organize, edit and save your notes. This layo
1. You need to setup a firebase project and enable 'Authentication' and 'Cloud Firestore' support
2. Once done, you need to setup .env file at the root of this repository

```bash
```properties
# https://api.cloudinary.com/v1_1/CLOUD_NAME/image/upload
REACT_APP_UPLOAD_IMAGE_URL=[x]

# firebase cloud funtion http endpoint for link preview
# firebase cloud function http endpoint for link preview
REACT_APP_LINK_PREVIEW=[x]

# firebase config
Expand All @@ -55,19 +55,19 @@ REACT_APP_MEASUREMENT_ID=[x]

### Editor (Solarized Dark)

![Ediotor Solarized Dark](screenshots/editor_dark.png)
![Editor Solarized Dark](screenshots/editor_dark.png)

### Editor (Gruvbox Dark)

![Ediotor Solarized Light](screenshots/editor_light.png)
![Editor Solarized Light](screenshots/editor_light.png)

### YT Video Embed (Gruvbox)

![YT Video Embed](screenshots/video_embed.png)

### Link Previews and Checkboxes (Nord)

![Link Previes and Checkboxes](screenshots/link_previews_checkboxes.png)
![Link Previews and Checkboxes](screenshots/link_previews_checkboxes.png)

## TODO

Expand Down