https://github.com/igmrrf/caption-cards
https://github.com/igmrrf/caption-cards
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/igmrrf/caption-cards
- Owner: igmrrf
- Created: 2020-02-24T12:48:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-04-07T04:35:01.000Z (about 2 months ago)
- Last Synced: 2025-04-07T05:27:27.646Z (about 2 months ago)
- Language: JavaScript
- Size: 1.89 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Welcome to CaptionCards!
#visit \*\*Caption Cards for current status.
This is a simple Front-End project built with React.js while using Redux as the state manager. The API was pre-built and Documentation on the API can be seen in the link below.
**API Documentation**---
## Documentation
CaptionCards holds in captions in cards for all categories of captions which are categorized by **Tags**
> **Note:**
> - Caption Cards is accessible **offline** and can be saved on mobile devices like a **native app**, although it's a web app.
> - Your local contents are not shared between different browsers or computers.
> - Clearing your browser's data and cache may **delete all your locally saved contents!**#### Create a Caption
The Caption panel is accessible using the contribute Nav link in the navigation bar. You can create a new Caption Card by clicking **Add Caption** in the dropdown panel.
#### Add a Tag(s)
To add a tag is familliar like creating a caption, and is accessed using the contribute Nav link in the navigation bar and by clicking **Add Tag(s)** in the dropdown panel.
#### Create a Caption with Tag(s)
The Create Caption option just lies in the dropdown explained above
And is accessible using the contribute Nav link in the navigation bar. You can create a new Caption Card by clicking **Add Caption with Tag(s)** in the dropdown panel.#### Get All Captions
Click on Browse on the Navigation and select **Captions** then in the Filter Section, mark **All**. You'll be shown 10 captions, and by clicking the next page button you get another 10 till you get all captions in the database.
#### Get All Tags
Click on Browse on the Navigation and select **Tags** then in the Filter Section, mark **All**. You'll be shown 20 tags, button you get another 20 till you get all tags in the database.
#### Delete a Caption
You can not delete captions, the API provided doesn't support such endpoints.
#### Delete a Tag
You can not delete Tags, the API provided doesn't support such endpoints any delete endpoints.
#### Edit a Caption
You cannot edit a caption.
> **Tip:** Check out the [ API Documentation](#api-documentation) section for a description of the different possible actions.
### Share Caption
You can copy captions by clicking the clipboard icon on the top right of each card to copy the contents of the caption card to your clipboard.
Your can paste this anywhere by pressingCtrl+v or long pressing on a text field on your mobile device.