Skip to content

Commit 507f062

Browse files
wajeshubhamwajeshubham
committed
Update README.md
1 parent 56e93f1 commit 507f062

File tree

1 file changed

+196
-22
lines changed

1 file changed

+196
-22
lines changed

‎README.md‎

Lines changed: 196 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,212 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
<!-- Improved compatibility of back to top link: See: https://github.com/wajeshubham/snippng/pull/73 -->
2+
3+
<a name="readme-top"></a>
4+
5+
<!--
6+
*** Thanks for checking out the Best-README-Template. If you have a suggestion
7+
*** that would make this better, please fork the repo and create a pull request
8+
*** or simply open an issue with the tag "enhancement".
9+
*** Don't forget to give the project a star!
10+
*** Thanks again! Now go create something AMAZING! :D
11+
-->
12+
13+
<!-- PROJECT SHIELDS -->
14+
<!--
15+
*** I'm using markdown "reference style" links for readability.
16+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
17+
*** See the bottom of this document for the declaration of the reference variables
18+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
19+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
20+
-->
21+
22+
[![Contributors][contributors-shield]][contributors-url]
23+
[![Forks][forks-shield]][forks-url]
24+
[![Stargazers][stars-shield]][stars-url]
25+
[![Issues][issues-shield]][issues-url]
26+
[![MIT License][license-shield]][license-url]
27+
[![LinkedIn][linkedin-shield]][linkedin-url]
28+
29+
<!-- PROJECT LOGO -->
30+
<br />
31+
<div align="center">
32+
33+
34+
<h3 style="font-size: 40px;display:inline-flex; align-items:center" align="center">
35+
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24"
36+
width="50px"
37+
height="50px"
38+
style="margin-right:12px"
39+
stroke-width="1" stroke="currentColor">
40+
<path stroke-linecap="round" stroke-linejoin="round" d="M6.75 7.5l3 2.25-3 2.25m4.5 0h3m-9 8.25h13.5A2.25 2.25 0 0021 18V6a2.25 2.25 0 00-2.25-2.25H5.25A2.25 2.25 0 003 6v12a2.25 2.25 0 002.25 2.25z" />
41+
</svg>
42+
Snippng</h3>
43+
44+
<p align="center">
45+
Create and share beautiful images of your source code.
46+
<br />
47+
<br/>
48+
<a href="https://snippng.wajeshubham.in">Generate snippets</a>
49+
·
50+
<a href="https://github.com/wajeshubham/snippng/issues">Report Bug</a>
51+
·
52+
<a href="https://github.com/wajeshubham/snippng/issues">Request Feature</a>
53+
</p>
54+
</div>
55+
56+
<!-- TABLE OF CONTENTS -->
57+
<details>
58+
<summary>Table of Contents</summary>
59+
<ol>
60+
<li>
61+
<a href="#about-the-project">About The Project</a>
62+
<ul>
63+
<li><a href="#built-with">Built With</a></li>
64+
</ul>
65+
</li>
66+
<li>
67+
<a href="#getting-started">Getting Started</a>
68+
<ul>
69+
<li><a href="#prerequisites">Prerequisites</a></li>
70+
<li><a href="#installation">Installation</a></li>
71+
</ul>
72+
</li>
73+
<li><a href="#contributing">Contributing</a></li>
74+
<li><a href="#license">License</a></li>
75+
<li><a href="#contact">Contact</a></li>
76+
</ol>
77+
</details>
78+
79+
<!-- ABOUT THE PROJECT -->
80+
81+
## About The Project
82+
83+
<a href="https://snippng.wajeshubham.in">
84+
<img src="https://wajeshubham-portfolio.s3.ap-south-1.amazonaws.com/snippng-cover.png" alt="Logo">
85+
</a>
86+
87+
Create and share beautiful images of your source code. Start typing or paste a code snippet into the text area to get started.
88+
89+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
90+
91+
## Built With
92+
93+
- [![Next][next.js]][next-url]
94+
- [![NodeJs][node.js]][node-url]
95+
- [![Typescript][typescript]][typescript-url]
96+
- [![React][react.js]][react-url]
97+
- [![tailwindcss][tailwindcss]][tailwindcss-url]
98+
- [![Firebase][firebase]][firebase-url]
99+
- [![Jest][jest]][jest-url]
100+
101+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
102+
103+
<!-- GETTING STARTED -->
2104

3105
## Getting Started
4106

5-
First, run the development server:
107+
To get a local copy up and running follow these steps.
108+
109+
### Prerequisites
110+
111+
You need `NodeJs` and `yarn` installed on your machine.
112+
113+
- yarn
114+
```sh
115+
npm install --global yarn
116+
```
117+
118+
### Installation
119+
120+
1. Clone the repo
121+
```sh
122+
git clone https://github.com/wajeshubham/snippng.git
123+
```
124+
2. Install NPM packages
125+
```sh
126+
yarn
127+
```
128+
129+
### Run locally
130+
131+
1. Run the development server
132+
```sh
133+
yarn dev
134+
```
135+
2. Run the test to test your changes
136+
```sh
137+
yarn test
138+
```
139+
140+
OR
141+
142+
1. Run using `docker`. make sur you have [Docker](https://docs.docker.com/get-docker/) installed on your machine.
143+
```sh
144+
docker-compose up --build
145+
```
146+
147+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
148+
149+
<!-- CONTRIBUTING -->
150+
151+
## Contributing
152+
153+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
6154

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
```
155+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
156+
Don't forget to give the project a star! Thanks again!
14157

15-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
158+
1. Fork the Project
159+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
160+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
161+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
162+
5. Open a Pull Request
16163

17-
You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
164+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
18165

19-
[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
166+
<!-- LICENSE -->
20167

21-
The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
168+
## License
22169

23-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
170+
Distributed under the MIT License. See `LICENSE.md` for more information.
24171

25-
## Learn More
172+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
26173

27-
To learn more about Next.js, take a look at the following resources:
174+
<!-- CONTACT -->
28175

29-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
30-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
176+
## Contact
31177

32-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
178+
Shubham Waje - [@linkedin/shubham-waje](https://linkedin.com/in/shubham-waje)
33179

34-
## Deploy on Vercel
180+
Project Link: [https://snippng.wajeshubham.in](https://snippng.wajeshubham.in)
35181

36-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
182+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
183+
<!-- MARKDOWN LINKS & IMAGES -->
184+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
37185

38-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
186+
[contributors-shield]: https://img.shields.io/github/contributors/wajeshubham/snippng?style=for-the-badge
187+
[contributors-url]: https://github.com/wajeshubham/snippng/graphs/contributors
188+
[forks-shield]: https://img.shields.io/github/forks/wajeshubham/snippng?style=for-the-badge
189+
[forks-url]: https://github.com/wajeshubham/snippng/network/members
190+
[stars-shield]: https://img.shields.io/github/stars/wajeshubham/snippng?style=for-the-badge
191+
[stars-url]: https://github.com/wajeshubham/snippng/stargazers
192+
[issues-shield]: https://img.shields.io/github/issues/wajeshubham/snippng?style=for-the-badge
193+
[issues-url]: https://github.com/wajeshubham/snippng/issues
194+
[license-shield]: https://img.shields.io/github/license/wajeshubham/snippng?style=for-the-badge
195+
[license-url]: https://github.com/wajeshubham/snippng/blob/master/LICENSE.md
196+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
197+
[linkedin-url]: https://linkedin.com/in/shubham-waje
198+
[product-screenshot]: images/screenshot.png
199+
[next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
200+
[next-url]: https://nextjs.org/
201+
[react.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
202+
[react-url]: https://reactjs.org/
203+
[tailwindcss]: https://img.shields.io/badge/Tailwind-000000?style=for-the-badge&logo=tailwindcss&logoColor=white
204+
[tailwindcss-url]: https://tailwindcss.com
205+
[typescript]: https://img.shields.io/badge/Typescript-000000?style=for-the-badge&logo=typescript&logoColor=white
206+
[typescript-url]: https://typescriptlang.org
207+
[firebase]: https://img.shields.io/badge/firebase-000000?style=for-the-badge&logo=firebase&logoColor=ffa611
208+
[firebase-url]: https://firebase.google.com/
209+
[node.js]: https://img.shields.io/badge/node.js-000000?style=for-the-badge&logo=node.js&logoColor=68a063
210+
[node-url]: https://nodejs.org/
211+
[jest]: https://img.shields.io/badge/jest-000000?style=for-the-badge&logo=jest&logoColor=c21325
212+
[jest-url]: https://jestjs.io/

0 commit comments

Comments
 (0)