Skip to content

Commit fd4086e

Browse files
committed
feat: More update to readme
1 parent 3d7bdd8 commit fd4086e

1 file changed

Lines changed: 80 additions & 4 deletions

File tree

README.md

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22

33
<p align="center">
4-
<a href="https://tryshape.vercel.app/ target="_blank">
4+
<a href="https://tryshape.vercel.app/" target="_blank">
55
<img src="./public/readme/TryShape-GitHub-icon-only.png" alt="logo" width="125"/>
66
</a>
77

@@ -25,7 +25,7 @@
2525
<a href="https://github.com/TryShape/tryshape/pulls" target="blank">
2626
<img src="https://img.shields.io/github/issues-pr/TryShape/tryshape?style=flat-square" alt="tryshape pull-requests"/>
2727
</a>
28-
<a href="https://twitter.com/intent/tweet?text=Check%20this%20amazing%20app%20https://tryshape.vercel.app/,%20created%20by%20@tapasadhikary%20and%20friends%0A%0A%23DEVCommunity%20%23100DaysOfCode%20%23tryshape"><img src="https://img.shields.io/twitter/url?label=Share%20on%20Twitter&style=social&url=https%3A%2F%2Fgithub.com%2FTryShape%2Ftryshape"></a>
28+
<a href="https://twitter.com/intent/tweet?text=👋%20Check%20this%20amazing%20app%20https://tryshape.vercel.app/,%20created%20by%20@tapasadhikary%20and%20friends%0A%0A%23DEVCommunity%20%23100DaysOfCode%20%23tryshape"><img src="https://img.shields.io/twitter/url?label=Share%20on%20Twitter&style=social&url=https%3A%2F%2Fgithub.com%2FTryShape%2Ftryshape"></a>
2929

3030
</p>
3131

@@ -39,7 +39,7 @@
3939

4040
## 👋 Introducing `TryShape`
4141
<p align="center">
42-
<a href="https://tryshape.vercel.app/ target="_blank">
42+
<a href="https://tryshape.vercel.app" target="blank"/>
4343
<img src="./public/readme/landing.png" alt="landing" />
4444
</a>
4545
</p>
@@ -51,6 +51,9 @@ TBA
5151

5252
## 🔥 Features
5353
`TryShape` comes with a bundle of features to give your creativity a shape. You can do the followings with TryShape,
54+
55+
### ✅ Listing Shapes
56+
- List out shapes for you to pick and use.
5457
### ✅ Create Shapes
5558
- Create any shapes using an intuitive editor.
5659
- Create Polygonal, Circular, Elliptical shapes without knowing the underlying complexities like CSS clip-path.
@@ -79,7 +82,69 @@ TBA
7982
- 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`.
8083

8184
## 🏗️ How to Set up `TryShape` for Development?
82-
TBA
85+
You can run TryShape locally with a few easy steps.
86+
87+
1. Clone the repository
88+
89+
```bash
90+
git clone https://github.com/TryShape/tryshape.git
91+
```
92+
93+
2. Change the working directory
94+
95+
```bash
96+
cd tryshape
97+
```
98+
99+
3. Install dependencies
100+
101+
```bash
102+
npm install # or, yarn install
103+
```
104+
105+
4. Create `.env` file in root and add your variables
106+
107+
```bash
108+
NEXT_PUBLIC_DB_URL= YOUR_HARPER_DB_DATABASE_URL
109+
NEXT_PUBLIC_DB_AUTHORIZATION= YOUR_HARPER_DB_AUTHORIZATION_ID
110+
111+
NEXT_PUBLIC_FIREBASE_AUTHORIZATION=YOUR_FIREBASE_AUTH_KEY
112+
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=YOUR_FIREBASE_AUTH_DOMAIN
113+
NEXT_PUBLIC_FIREBASE_PROJECT_ID=YOUR_FIREBASE_PROJECT_ID
114+
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=YOUR_FIREBASE_PROJECT_BUCKET
115+
NEXT_PUBLIC_FIREBASE_MESSAGING_SERNDER_ID=YOUR_FIREBASE_MESSAGING_SERNDER_ID
116+
NEXT_PUBLIC_FIREBASE_APP_ID=YOUR_FIREBASE_APP_ID
117+
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=YOUR_FIREBASE_MEASUREMENT_ID
118+
```
119+
120+
5. Run the app
121+
122+
```bash
123+
npm run dev # or, yarn dev
124+
```
125+
126+
That's All!!! Now open [localhost:3000](http://localhost:3000/) to see the app.
127+
128+
## 🍔 Built With
129+
- [Next JS](https://nextjs.org/): The coolest React-based framework on the planet
130+
- [Harper DB](https://harperdb.io/): A flexible Data Store
131+
- [react-icons](https://react-icons.github.io/react-icons/): One shop for all the icons
132+
- [react-hot-toast](https://react-hot-toast.com/): Super cool toast messages
133+
- [firebase](https://firebase.google.com/): Authentication services
134+
- [date-fns](https://date-fns.org/): Date formatting
135+
- [axios](https://github.com/axios/axios): Makes API calls easy
136+
- [react-bootstrap](https://react-bootstrap.github.io/): A popular frontend framework built-for React
137+
- [Styled Components](https://styled-components.com/): Visual primitives for the component age
138+
- [react-clip-path](https://github.com/atapas/react-clip-path#readme): A home grown module to handle clip-path property in a React app.
139+
- [react-draggable](https://github.com/mzabriskie/react-draggable): Make a HTML element draggable in React
140+
- [react-loader-spinner](https://mhnpd.github.io/react-loader-spinner/): Provides simple React SVG spinner component which can be implemented for async await operation before data loads to the view
141+
- [react-switch](https://github.com/markusenglund/react-switch#readme): A draggable toggle-switch component for React.
142+
- [downloadjs](http://danml.com/download.html): Trigger a download from JavaScript
143+
- [html-to-image](https://github.com/bubkoo/html-to-image#readme): Converts an HTML element to image
144+
- [Vercel](http://vercel.com/): Best for Hosting a Next.js app
145+
146+
## 🛡️ License
147+
This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.
83148

84149
## 🦄 Upcoming Features
85150
`TryShape` has all the potentials to grow further. Here are some of the upcoming features planned(not in any order),
@@ -94,10 +159,21 @@ TBA
94159
- ✔️ Flexible Datastore
95160
- ✔️ Better Performance
96161
- ✔️ Tagging a shape
162+
- ✔️ Cloning a shape
97163
- ✔️ Provide comment on a shape.
98164
- ✔️ More authetication mechanisms like twitter, facebook, etc.
99165

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

168+
## 🏃‍♀️ Deploy
169+
170+
<a href="https://vercel.com/new/project?template=https://github.com/TryShape/tryshape">
171+
<img src="https://vercel.com/button" height="37.5px" />
172+
</a>
173+
<a href="https://app.netlify.com/start/deploy?repository=https://github.com/TryShape/tryshape">
174+
<img src="https://www.netlify.com/img/deploy/button.svg" height="37.5px" />
175+
</a>
176+
177+
102178
## 🤝 Contributions
103179
TBA

0 commit comments

Comments
 (0)