Skip to content

Commit 45dee52

Browse files
authored
Create README.md
1 parent 1cc126f commit 45dee52

1 file changed

Lines changed: 91 additions & 0 deletions

File tree

README.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
<h1 align="center">
2+
<a href="https://expo.dev/@martstech/snapchat-clone/">
3+
<img width="200px" src="https://raw.githubusercontent.com/MartsTech/reddit-clone/main/images/logo.png" alt="Reddit Logo" />
4+
</a>
5+
<br />
6+
Reddit Clone
7+
<br />
8+
</h1>
9+
10+
<h4 align="center">
11+
Reddit Close created with Next.JS, GraphQL, Stepzen and Supabase
12+
</h4>
13+
14+
<div align="center">
15+
<img src="https://img.shields.io/github/v/release/MartsTech/reddit-clone" alt="Release" />
16+
<img src="https://vercelbadge.vercel.app/api/MartsTech/reddit-clone" alt="Deployment" />
17+
<img src="https://img.shields.io/github/license/MartsTech/reddit-clone" alt="License" />
18+
</div>
19+
20+
<div align="center">
21+
<a href="#demo">Demo</a> •
22+
<a href="#key-features">Key Features</a> •
23+
<a href="#key-technologies">Key Technologies</a> •
24+
<a href="#setup">Setup</a> •
25+
<a href="#support">Support</a> •
26+
<a href="#license">License</a>
27+
</div>
28+
29+
<img style="object-fit: contain" src="https://raw.githubusercontent.com/MartsTech/reddit-clone/main/images/post.png" alt="post" />
30+
<img style="object-fit: contain" src="https://raw.githubusercontent.com/MartsTech/reddit-clone/main/images/subreddit.png" alt="subreddit" />
31+
32+
---
33+
34+
## Demo
35+
36+
Here is a working live demo [here](https://expo.dev/@martstech/snapchat-clone/)
37+
38+
---
39+
40+
## Key Features
41+
42+
- Reddit Auth
43+
- Paginated Posts
44+
- Subreddit (Posts grouped by topic)
45+
- Create Post
46+
- Votes
47+
- Comments
48+
- Top Communities
49+
- Server Side Rendering
50+
51+
---
52+
53+
## Key Technologies
54+
55+
- React
56+
- Next.JS
57+
- TailwindCSS
58+
- GraphQL
59+
- Stepzen
60+
- Supabase
61+
- NextAuth
62+
63+
---
64+
65+
## Setup
66+
67+
Clone this repo to your desktop and run `yarn install` in /pachages/client to install all the dependencies.
68+
Then run `yarn dev` to start the application locally
69+
70+
Install the stepzen cli globally and
71+
Then run `stepzen start` in /pachages/api to start the api locally
72+
73+
Change the .env.example file to .env.local in /pachages/client and fill the empty fields
74+
75+
---
76+
77+
## Support
78+
79+
Whether you use this project, have learned something from it, or just like it, please consider supporting it by buying me a coffee, so I can dedicate more time on open-source projects like this :)
80+
81+
<a href="https://www.buymeacoffee.com/martstech" target="_blank">
82+
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="60px" width="217px" />
83+
</a>
84+
85+
---
86+
87+
## License
88+
89+
> You can check out the full license [here](https://github.com/MartsTech/reddit-clone/blob/main/LICENSE)
90+
91+
This project is licensed under the terms of the **MIT** license

0 commit comments

Comments
 (0)