add standard documents (#18)

* update `AUTHORS.md`

* update `CHANGELOG.md`

* update `README.md`

* add `RELEASE.md`

* add standard fields to `package.json`

* unused files removed

* update discord url

* add `.vscode` to `.gitignore`

* update email address in `README.md`

* change homepage in `package.json`

* TOC removed, shields.io badges added

* CNAME added

* manifest.json updated

* email updated

* email updated

* convert Markdown badges to pure html badges

* change TS badge

* fix the alignment [fixing height]

---------

Co-authored-by: AHReccese <[email protected]>

.github/CODE_OF_CONDUCT.md

@@ -58,7 +58,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-info@openscilab.com.
+mybutton@openscilab.com.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

.gitignore

@@ -4,8 +4,8 @@
 /node_modules
 /.pnp
 .pnp.js
-# yarn.lock
-
+# vscode
+/.vscode
 # testing
 /coverage
 

AUTHORS.md

@@ -1,10 +1,12 @@
-# Authors #
+# Authors
 
-----------
-- AmirHosein Rostami  - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
+---
 
+-   AmirHosein Rostami - Open Science Laboratory ([Github](https://github.com/AHReccese))
+-   Fatemeh Shahali ([Github](https://github.com/F-Shahali)) \*\*
 
-** **Maintainer**
+\*\* **Maintainer**
 
-# Other Contributors #
-----------
+# Other Contributors
+
+---

CHANGELOG.md

@@ -1,19 +1,20 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-## [0.1] - 202x-xx-xx
+
+## [0.1] - 2024-xx-xx
+
 ### Added
-- Item1
-- Item2
-- Item3
-### Changed 
-- Item1
-- Item2
-- Item3
+
+-   `Email` support
+-   `Gmail` support
+-   `Telegram` support
+-   Choose direct or indirect sharing mode
 
 [Unreleased]: https://github.com/openscilab/mybutton/compare/v0.1...dev
-[0.1]: https://github.com/openscilab/mybutton/compare/c6df6cc...v0.1
+[0.1]: https://github.com/openscilab/mybutton/compare/c6df6cc...v0.1

README.md

@@ -1 +1,49 @@
-# mybutton
+<div align="center">
+<a href="https://reactjs.org/">
+  <img src="https://img.shields.io/badge/react-black?logo=react&style=for-the-badge" alt="React" style="height: 24px;">
+</a>
+<a href="https://www.typescriptlang.org/">
+  <img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=FFF&style=flat-square" alt="TypeScript" style="height: 24px;">
+</a>
+<a href="https://discord.gg/T2VzhzqU67">
+  <img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel" style="height: 24px;">
+</a>
+</div>
+
+## Overview
+MyButton is an open-source project that streamlines the process of sharing links to your preferred online services. It provides a user-friendly interface that allows users to seamlessly share content with just a few clicks. MyButton takes care of the technical aspects. Depending on the chosen service, it might:
+
+-   Redirect you directly to the platform with the link pre-populated.
+-   Generate sharable buttons embedded with your link. Clicking these buttons redirects users to the chosen service.
+
+## Supported services
+
+| Service name | Support  |
+| ------------ | -------- |
+| Email        | &#x2705; |
+| Gmail        | &#x2705; |
+| Telegram     | &#x2705; |
+
+## Issues & bug reports
+
+Just fill an issue and describe it. We'll check it ASAP! or send an email to [[email protected]](mailto:[email protected] '[email protected]').
+
+-   Please complete the issue template
+
+You can also join our discord server
+
+<a href="https://discord.gg/T2VzhzqU67">
+  <img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
+</a>
+
+## Show Your Support
+
+<h3>Star this repo</h3>
+
+Give a ⭐️ if this project helped you!
+
+<h3>Donate to our project</h3>
+
+If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
+
+<a href="https://openscilab.com/#donation" target="_blank"><img src="https://github.com/openscilab/mybutton/raw/main/otherfiles/donation.png" height="90px" width="270px" alt="mybutton Donation"></a>

otherfiles/RELEASE.md

@@ -0,0 +1,35 @@
+# MyButton Release Instructions
+
+#### Last Update: 2024-06-15
+
+1. Create the `release` branch under `dev`
+2. Update all version tags
+    1. `package.json`
+    2. `README.md`
+3. Update `CHANGELOG.md`
+    1. Add a new header under `Unreleased` section (Example: `## [0.1] - 2022-08-17`)
+    2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/openscilab/mybutton/compare/v0.1...v0.2`)
+    3. Update `dev` compare link (Example: `[Unreleased]: https://github.com/openscilab/mybutton/compare/v0.2...dev`)
+4. Create a PR from `release` to `dev`
+    1. Title: `Version x.x` (Example: `Version 0.1`)
+    2. Tag all related issues
+    3. Labels: `release`
+    4. Set milestone
+    5. Wait for all CI pass
+    6. Need review (**2** reviewers)
+    7. Squash and merge
+    8. Delete `release` branch
+5. Merge `dev` branch into `main`
+    1. `git checkout main`
+    2. `git merge dev`
+    3. `git push origin main`
+    4. Wait for all CI pass
+6. Create a new release
+    1. Target branch: `main`
+    2. Tag: `vx.x` (Example: `v0.1`)
+    3. Title: `Version x.x` (Example: `Version 0.1`)
+    4. Copy changelogs
+    5. Tag all related issues
+7. Bump!!
+8. Close this version issues
+9. Close milestone

package.json

@@ -1,7 +1,20 @@
 {
-	"name": "react-ts",
+	"name": "mybutton",
+	"description": "Effortless link sharing across your desired platforms",
 	"version": "0.1.0",
-	"private": true,
+	"author": "MyButton Development Team",
+	"license": "MIT",
+	"homepage": "https://mybutton.click",
+	"bugs": "https://github.com/openscilab/mybutton/issues",
+	"keywords": [
+		"url-sharing",
+		"open-source",
+		"link-sharing",
+		"share-buttons",
+		"web-development",
+		"platform-integration",
+		"social-media-sharing"
+	],
 	"cracoConfig": "craco.config.js",
 	"dependencies": {
 		"@craco/craco": "^6.2.0",

public/CNAME

@@ -0,0 +1 @@
+mybutton.click

public/manifest.json

@@ -1,6 +1,6 @@
 {
-	"short_name": "<APP_SHORT_NAME>",
-	"name": "<APP_NAME>",
+	"short_name": "MyButton",
+	"name": "MyButton",
 	"icons": [],
 	"start_url": ".",
 	"display": "standalone",

src/Components/ErrorBoundary/ErrorBoundary.tsx

@@ -41,7 +41,7 @@ export default class ErrorBoundary extends Component<EBProps> {
 					Back to home
 					{this.state.remainTime !== 0 ? ` (${this.state.remainTime}s)` : ''}
 				</Button>
-				<Button className='report-btn' href='mailto:info@openscilab.com'>
+				<Button className='report-btn' href='mailto:mybutton@openscilab.com'>
 					Report to OSL
 				</Button>
 			</div>