Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashenjayathilaka/reddit-clone
Reddit Clone with REACTJS (Next.js, Firebase v9, Chakra UI, TypeScript, Recoil, (Image Uploading, Google Authentication, Create Community, Join Community, Leave Community, Upvote and Downvote Posts), Dark Mode & Light Mode, Data Encryption and Decryption)
https://github.com/sashenjayathilaka/reddit-clone
chakra-ui chakra-ui-icons emotion-react firebase firebase-auth firebase-database firebase-functions firestore fontsource framer-motion learn moment nextjs react react-dom react-firebase-hooks react-icons recoil typescript vercel-deployment
Last synced: about 6 hours ago
JSON representation
Reddit Clone with REACTJS (Next.js, Firebase v9, Chakra UI, TypeScript, Recoil, (Image Uploading, Google Authentication, Create Community, Join Community, Leave Community, Upvote and Downvote Posts), Dark Mode & Light Mode, Data Encryption and Decryption)
- Host: GitHub
- URL: https://github.com/sashenjayathilaka/reddit-clone
- Owner: SashenJayathilaka
- Created: 2022-08-29T13:56:45.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T13:55:21.000Z (over 1 year ago)
- Last Synced: 2024-09-24T12:52:23.906Z (about 6 hours ago)
- Topics: chakra-ui, chakra-ui-icons, emotion-react, firebase, firebase-auth, firebase-database, firebase-functions, firestore, fontsource, framer-motion, learn, moment, nextjs, react, react-dom, react-firebase-hooks, react-icons, recoil, typescript, vercel-deployment
- Language: TypeScript
- Homepage: https://reddit-sclone.vercel.app
- Size: 26.5 MB
- Stars: 128
- Watchers: 5
- Forks: 49
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Reddit Clone with REACT.JS
Reddit Clone with REACTJS (Next.js, Firebase v9, Chakra UI, TypeScript, Recoil, (Image Uploading, Google Authentication, Create Community, Join Community, Leave Community, Upvote and Downvote Posts), Dark Mode & Light Mode, Data Encryption and Decryption)
View Demo
·
Documentation
·
Report Bug
·
Request Feature
## :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Installation](#gear-installation)
- [Run Locally](#running-run-locally)
- [Deployment](#triangular_flag_on_post-deployment)
- [Contact](#handshake-contact)
## :star2: About the Project
### :camera: Screenshots
- Create Community, Join Community, Leave Community, Upvote and Downvote Posts
- Dark Mode & Light Mode
- User Profile Section
- Conversation Section (Reddit Clone Live Chat)
## LIVE DEMO 💥
#### 🔴 Open the camera app on your device and scan the code below (live demo)
### :space_invader: Tech Stack
Client
Database
Functions
## :toolbox: Getting Started
### :bangbang: Prerequisites
- Sign up for a Firebase account HERE
- Install Node JS in your computer HERE
### :key: Environment Variables
To run this project, you will need to add the following environment variables to your .env file
`NEXT_PUBLIC_FIREBASE_API_KEY`
`NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN`
`NEXT_PUBLIC_FIREBASE_PROJECT_ID`
`NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET`
`NEXT_PUBLIC_FIREBASE_MESSAGING_SET`
`NEXT_PUBLIC_FIREBASE_APP_ID`
`NEXT_PUBLIC_BASE_URL`
`NEXT_PUBLIC_CRYPTO_SECRET_PASS`
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
### :gear: Installation
Install my-project with npm
```
npx create-next-app@latest --ts my-project
```
```
cd my-project
```
Install dependencies
### In your Next.js project, install Chakra UI
#### Installation
In your Next.js project, install Chakra UI by running either of the following:
```
npm i @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6
or
yarn add @chakra-ui/react @emotion/react@^11 @emotion/styled@^11 framer-motion@^6
```
Provider Setup
After installing Chakra UI, you need to set up the `ChakraProvider` at the root of your application.
Go to `pages/_app.js` or `pages/_app.tsx` (create it if it doesn't exist) and wrap the `Component` with the `ChakraProvider`:
```tsx
// pages/_app.js
import { ChakraProvider } from "@chakra-ui/react";
function MyApp({ Component, pageProps }) {
return (
);
}
export default MyApp;
```
Install dependencies
### :running: Run Locally
Clone the project
```bash
git clone https://github.com/SashenJayathilaka/Reddit-Clone.git
```
change directory
```bash
cd Reddit-Clone
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
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).
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.
[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.js`.
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.
### Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### :triangular_flag_on_post: Deployment
To deploy this project run
##### Deploy on Vercel
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.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## :handshake: Contact
Sashen - [@twitter_handle](https://twitter.com/SashenHasinduJ) - [email protected]
Project Link: [https://github.com/SashenJayathilaka/Reddit-Clone.git](https://github.com/SashenJayathilaka/Reddit-Clone.git)