From a2f09a71ac7b35ce9f6eebf2b0999fb37658fa63 Mon Sep 17 00:00:00 2001
From: ALOK9442 <104527572+ALOK9442@users.noreply.github.com>
Date: Sun, 14 Jan 2024 06:25:21 +0530
Subject: [PATCH] Update README.md
---
README.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++++---
1 file changed, 75 insertions(+), 4 deletions(-)
diff --git a/README.md b/README.md
index f768e33..134f6d1 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,79 @@
# React + Vite
+# CryptBee
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+CryptBee is a trading crypto website made using ReactJs for the frontend and Django for the backend. This repository contains the code for the frontend part of the website. The backend repository can be found [here](https://github.com/anshumannandan/cryptBEE).
-Currently, two official plugins are available:
+## Libraries used
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+- [Redux-toolkit](https://redux-toolkit.js.org/) - A provider-based state management library for Reactjs.
+- [React-router-dom](https://reactrouter.com/en/main) - A routing library for react with support of dynamic-routing.
+- [Firebase Dynamic Linking](https://firebase.google.com/docs/dynamic-links) - A tool used for email verification.
+
+## Features
+
+- Email and Phone verification
+- Two-Factor Authentication (Enable/Disable)
+- WebSockets
+- WebScrapped News
+- Real time cryptocurrency data
+- Real time crypto NEWS
+- Buy, Sell, Transaction History
+- Profit/Loss Calculator
+
+## Screenshots
+
+
+ 
+
+
+
+ 
+ 
+ 
+ 
+ 
+
+
+
+ 
+ 
+ 
+ 
+ 
+
+
+## Running the Website
+
+To run the website, you need to have NodeJs installed on your machine. If you don't have it installed, you can follow the instructions [here](https://nodejs.org/en/learn/getting-started/how-to-install-nodejs) to install it.
+
+1. Clone the repository:
+
+```CMD
+git clone https://github.com/ALOK9442/cryptbeeWeb.git
+```
+
+2. Navigate to the project directory:
+
+```CMD
+cd cryptbeeWeb
+```
+
+3. Install the dependencies:
+
+```CMD
+npm install
+```
+
+4. Run the website on localhost:
+
+```CMD
+npm run dev
+```
+
+## Backend Contributor
+
+[Anshuman Nandan](https://github.com/anshumannandan) - Contributed to the backend part of the app.
+
+## Contributing
+
+We welcome contributions to CryptBee! Whether it's fixing bugs, improving performance, or adding new features, every contribution helps make CryptBee a better website.