Skip to content

Commit f6a3543

Browse files
committed
Merge remote-tracking branch 'origin/main' into issue-58-clip-path-without-spaces-do-not-render-DraggableVertices
2 parents 8157513 + ee3cf16 commit f6a3543

File tree

12 files changed

+3740
-239
lines changed

12 files changed

+3740
-239
lines changed

.all-contributorsrc

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{
2+
"files": [
3+
"README.md"
4+
],
5+
"imageSize": 100,
6+
"commit": false,
7+
"contributors": [
8+
{
9+
"login": "atapas",
10+
"name": "Tapas Adhikary",
11+
"avatar_url": "https://avatars.githubusercontent.com/u/3633137?v=4",
12+
"profile": "https://tapasadhikary.com",
13+
"contributions": [
14+
"code",
15+
"infra",
16+
"test"
17+
]
18+
},
19+
{
20+
"login": "nirmalkc",
21+
"name": "Nirmal Kumar",
22+
"avatar_url": "https://avatars.githubusercontent.com/u/6359059?v=4",
23+
"profile": "https://github.com/nirmalkc",
24+
"contributions": [
25+
"test",
26+
"code"
27+
]
28+
},
29+
{
30+
"login": "williamzhu17",
31+
"name": "William Zhu",
32+
"avatar_url": "https://avatars.githubusercontent.com/u/77871333?v=4",
33+
"profile": "https://github.com/williamzhu17",
34+
"contributions": [
35+
"test",
36+
"code"
37+
]
38+
},
39+
{
40+
"login": "saviomartin",
41+
"name": "Savio Martin",
42+
"avatar_url": "https://avatars.githubusercontent.com/u/61895712?v=4",
43+
"profile": "https://savio.xyz/",
44+
"contributions": [
45+
"test",
46+
"code"
47+
]
48+
}
49+
],
50+
"contributorsPerLine": 7,
51+
"projectName": "tryshape",
52+
"projectOwner": "TryShape",
53+
"repoType": "github",
54+
"repoHost": "https://github.com",
55+
"skipCi": true
56+
}

CONTRIBUTING.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.
18+
19+
## Code of Conduct
20+
21+
### Our Pledge
22+
23+
In the interest of fostering an open and welcoming environment, we as
24+
contributors and maintainers pledge to making participation in our project and
25+
our community a harassment-free experience for everyone, regardless of age, body
26+
size, disability, ethnicity, gender identity and expression, level of experience,
27+
nationality, personal appearance, race, religion, or sexual identity and
28+
orientation.
29+
30+
### Our Standards
31+
32+
Examples of behavior that contributes to creating a positive environment
33+
include:
34+
35+
* Using welcoming and inclusive language
36+
* Being respectful of differing viewpoints and experiences
37+
* Gracefully accepting constructive criticism
38+
* Focusing on what is best for the community
39+
* Showing empathy towards other community members
40+
41+
Examples of unacceptable behavior by participants include:
42+
43+
* The use of sexualized language or imagery and unwelcome sexual attention or
44+
advances
45+
* Trolling, insulting/derogatory comments, and personal or political attacks
46+
* Public or private harassment
47+
* Publishing others' private information, such as a physical or electronic
48+
address, without explicit permission
49+
* Other conduct which could reasonably be considered inappropriate in a
50+
professional setting
51+
52+
### Our Responsibilities
53+
54+
Project maintainers are responsible for clarifying the standards of acceptable
55+
behavior and are expected to take appropriate and fair corrective action in
56+
response to any instances of unacceptable behavior.
57+
58+
Project maintainers have the right and responsibility to remove, edit, or
59+
reject comments, commits, code, wiki edits, issues, and other contributions
60+
that are not aligned to this Code of Conduct, or to ban temporarily or
61+
permanently any contributor for other behaviors that they deem inappropriate,
62+
threatening, offensive, or harmful.
63+
64+
### Scope
65+
66+
This Code of Conduct applies both within project spaces and in public spaces
67+
when an individual is representing the project or its community. Examples of
68+
representing a project or community include using an official project e-mail
69+
address, posting via an official social media account, or acting as an appointed
70+
representative at an online or offline event. Representation of a project may be
71+
further defined and clarified by project maintainers.
72+
73+
### Enforcement
74+
75+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
76+
reported by contacting the project team at [[email protected]]([email protected]). All
77+
complaints will be reviewed and investigated and will result in a response that
78+
is deemed necessary and appropriate to the circumstances. The project team is
79+
obligated to maintain confidentiality with regard to the reporter of an incident.
80+
Further details of specific enforcement policies may be posted separately.
81+
82+
Project maintainers who do not follow or enforce the Code of Conduct in good
83+
faith may face temporary or permanent repercussions as determined by other
84+
members of the project's leadership.
85+
86+
### Attribution
87+
88+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
89+
available at [http://contributor-covenant.org/version/1/4][version]
90+
91+
[homepage]: http://contributor-covenant.org
92+
[version]: http://contributor-covenant.org/version/1/4/

README.md

Lines changed: 60 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11

2-
2+
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
3+
[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
4+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
35
<p align="center">
46
<a href="https://tryshape.vercel.app/" target="_blank">
57
<img src="./public/readme/TryShape-GitHub-icon-only.png" alt="logo" width="125"/>
68
</a>
79

810
<p/>
11+
<p align="center">
12+
<img src="./public/readme/tryshape-text-transparent.png" alt="name"/>
13+
<p/>
914

1015
<h4 align="center">Create, Export, Share, and Use any Shapes of your choice.</h4>
1116

@@ -37,7 +42,7 @@
3742
<a href="https://github.com/TryShape/tryshape/issues/new/choose">Request Feature</a>
3843
</p>
3944

40-
## 👋 Introducing `TryShape`
45+
# 👋 Introducing `TryShape`
4146
<p align="center">
4247
<a href="https://tryshape.vercel.app" target="blank"/>
4348
<img src="./public/readme/landing.png" alt="landing" />
@@ -46,53 +51,56 @@
4651

4752
`TryShape` is an opensource platform to create shapes of your choice using a simple, easy-to-use interface. You can create banners, circles, polygonal shapes, export them as SVG, PNG, and even as CSS.
4853

49-
## 🚀 Demo
54+
# 🚀 Demo
5055
Here is a quick demo of the app. We hope you enjoy it.
5156

5257
> [The Demo Link](https://www.youtube.com/watch?v=CB9xkhzkrYE)
5358
5459
Liked it? Please give a ⭐️ to <b>TryShape</b> to build its triceps 💪 stronger.
5560

56-
## 💻 Use TryShape
61+
# 💻 Use TryShape
5762
Please access TryShape using the URL:
5863

5964
> https://tryshape.vercel.app/
6065
61-
## 🔥 Features
62-
`TryShape` comes with a bundle of features to give your creativity a shape. You can do the followings with TryShape,
66+
# 🔥 Features
67+
`TryShape` comes with a bundle of features already. You can do the followings with it,
6368

64-
### ✅ Listing Shapes
65-
- List out shapes for you to pick and use.
66-
### ✅ Create Shapes
69+
## 🔢 Listing Shapes
70+
- List out shapes for you to pick and use.
71+
72+
## 🏗️ Create Shapes
6773
- Create any shapes using an intuitive editor.
6874
- Create Polygonal, Circular, Elliptical shapes without knowing the underlying complexities like CSS clip-path.
6975
- Add/Remove vertices, join them, drag-drop to position them to create a shape.
7076
- Provide your choice of colors, add the contextual information as notes while creating the shapes.
7177
- Are you an expert in CSS clip-path? Great, you can add a clip-path value directly and start from there.
7278

73-
### Controlling the Visibility of Shapes
74-
- You can create a shape and share with the TryShape community by making it public.
79+
## 📢 Controlling the Visibility of Shapes
80+
- You can create a shape and share it with the TryShape community by making it public.
7581
- Do you want to keep your creativity private? No worries, that's possible too.
7682

77-
### Like Shapes
78-
- Liked a shape and want to to add it to your shape collection? You can do that just with a click. Want to undo? That's supported as well.
83+
## 💘 Like Shapes
84+
- Liked a shape and want to add it to your shape collection? You can do that just with a click. Want to undo? That's supported as well.
7985

80-
### Export Shapes
86+
## Export Shapes
8187
- Export the shapes to use in your application.
8288
- Export the shapes as PNG, JPEG, and SVG files.
83-
- Single-Click Copy of the undering CSS and clip-path proprty to use directly into your webapp.
89+
- Single-Click Copy of the underlying CSS and clip-path property to use directly into your web app.
8490

85-
### Search Shapes
91+
## 🔍 Search Shapes
8692
- Search a shape with key-in search.
8793

88-
### Sort Shapes
94+
## 🎿 Sort Shapes
8995
- Sort shapes by, most liked, recent, and oldest.
90-
### ✅ Authentication & Authorization
91-
- Features like export, like, create, edit shapes need you to autheticate with the app. You can use your Gmail or GitHub credntials to authenticate to the app. It is secured and powered by `Google Firebase`.
92-
### ✅ Responsive and Mobile Friendly
93-
- Use `TryShape` seamlessly from any devices.
9496

95-
## 🏗️ How to Set up `TryShape` for Development?
97+
## 🔑 Authentication & Authorization
98+
- Features like export, like, create, edit shapes need you to authenticate with the app. You can use your Gmail or GitHub credentials to authenticate to the app. It is secured and powered by `Google Firebase`.
99+
100+
## 📱 Responsive and mobile-friendly
101+
- Use `TryShape` seamlessly from any device.
102+
103+
# 🏗️ How to Set up `TryShape` for Development?
96104
You can run TryShape locally with a few easy steps.
97105

98106
1. Clone the repository
@@ -136,7 +144,7 @@ npm run dev # or, yarn dev
136144

137145
That's All!!! Now open [localhost:3000](http://localhost:3000/) to see the app.
138146

139-
## 🍔 Built With
147+
# 🍔 Built With
140148
- [Next JS](https://nextjs.org/): The coolest React-based framework on the planet
141149
- [Harper DB](https://harperdb.io/): A flexible Data Store
142150
- [react-icons](https://react-icons.github.io/react-icons/): One shop for all the icons
@@ -154,10 +162,10 @@ That's All!!! Now open [localhost:3000](http://localhost:3000/) to see the app.
154162
- [html-to-image](https://github.com/bubkoo/html-to-image#readme): Converts an HTML element to image
155163
- [Vercel](http://vercel.com/): Best for Hosting a Next.js app
156164

157-
## 🛡️ License
165+
# 🛡️ License
158166
This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.
159167

160-
## 🦄 Upcoming Features
168+
# 🦄 Upcoming Features
161169
`TryShape` has all the potentials to grow further. Here are some of the upcoming features planned(not in any order),
162170

163171
- ✔️ Add the ability to create shape using SVG elements to support Curvy Node adjustments.
@@ -176,7 +184,7 @@ This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) fi
176184

177185
If you find something is missing, `TryShape` is listening. Please create a feature request [from here](https://github.com/TryShape/tryshape/issues/new/choose).
178186

179-
## 🏃‍♀️ Deploy
187+
# 🏃‍♀️ Deploy
180188

181189
<a href="https://vercel.com/new/project?template=https://github.com/TryShape/tryshape">
182190
<img src="https://vercel.com/button" height="37.5px" />
@@ -186,14 +194,14 @@ If you find something is missing, `TryShape` is listening. Please create a featu
186194
</a>
187195

188196

189-
## 🤝 Contributing to `TryShape`
190-
Any kind of positive contributions are welcome! Please help us to grow by contributing to the project.
197+
# 🤝 Contributing to `TryShape`
198+
Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.
191199

192200
If you wish to contribute, you can work on any features [listed here](https://github.com/TryShape/tryshape#-upcoming-features) or create one on your own. After adding your code, please send us a Pull Request.
193201

194202
> Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
195203
196-
## 🙏 Support
204+
# 🙏 Support
197205

198206
We all need support and motivation. `TryShape` is not an exception. Please give this project a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.
199207

@@ -209,3 +217,26 @@ If you found the app helpful, consider supporting us with a coffee.
209217
A ⭐️ to <b>TryShape</b> is to build its triceps 💪 stronger.
210218
</h3>
211219

220+
221+
## Contributors ✨
222+
223+
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
224+
225+
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
226+
<!-- prettier-ignore-start -->
227+
<!-- markdownlint-disable -->
228+
<table>
229+
<tr>
230+
<td align="center"><a href="https://tapasadhikary.com"><img src="https://avatars.githubusercontent.com/u/3633137?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tapas Adhikary</b></sub></a><br /><a href="https://github.com/TryShape/tryshape/commits?author=atapas" title="Code">💻</a> <a href="#infra-atapas" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/TryShape/tryshape/commits?author=atapas" title="Tests">⚠️</a></td>
231+
<td align="center"><a href="https://github.com/nirmalkc"><img src="https://avatars.githubusercontent.com/u/6359059?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Nirmal Kumar</b></sub></a><br /><a href="https://github.com/TryShape/tryshape/commits?author=nirmalkc" title="Tests">⚠️</a> <a href="https://github.com/TryShape/tryshape/commits?author=nirmalkc" title="Code">💻</a></td>
232+
<td align="center"><a href="https://github.com/williamzhu17"><img src="https://avatars.githubusercontent.com/u/77871333?v=4?s=100" width="100px;" alt=""/><br /><sub><b>William Zhu</b></sub></a><br /><a href="https://github.com/TryShape/tryshape/commits?author=williamzhu17" title="Tests">⚠️</a> <a href="https://github.com/TryShape/tryshape/commits?author=williamzhu17" title="Code">💻</a></td>
233+
<td align="center"><a href="https://savio.xyz/"><img src="https://avatars.githubusercontent.com/u/61895712?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Savio Martin</b></sub></a><br /><a href="https://github.com/TryShape/tryshape/commits?author=saviomartin" title="Tests">⚠️</a> <a href="https://github.com/TryShape/tryshape/commits?author=saviomartin" title="Code">💻</a></td>
234+
</tr>
235+
</table>
236+
237+
<!-- markdownlint-restore -->
238+
<!-- prettier-ignore-end -->
239+
240+
<!-- ALL-CONTRIBUTORS-LIST:END -->
241+
242+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)