diff --git a/README.md b/README.md index d492a4a..b35d831 100644 --- a/README.md +++ b/README.md @@ -1 +1,112 @@ -## CryptoWallet Cypher + +# Cypher - Blockchain Payment Wallet + +Cypher is a Cross Platform Mobile Based Native Application that has features of a crypto wallet and crypto trading app It has it's own block-Chain Cryptocurrency Cypher(CYP) which you can invest in as well as other Cryptocurrencies available in market. + + +## Demo + +###### Cypher Website URL : https://cypee.netlify.app/ +###### Direct Download (For Android Users) : +###### Version 2.1.0 (Recmonded) [![Cypher for Android - Version 2.1.0](https://custom-icon-badges.herokuapp.com/badge/-Download-blue?style=for-the-badge&logo=download&logoColor=white "Cypher for Android - Version 2.1.0")](https://drive.google.com/file/d/14ANfN5I6gm8GqbzRMPw4Rfrq_4uVTohO/view?usp=sharing) + +###### Version 1.0.5 [![Cypher for Android - Version 1.0.5 ](https://custom-icon-badges.herokuapp.com/badge/-Download-blue?style=for-the-badge&logo=download&logoColor=white "Cypher for Android - Version 1.0.5")](https://drive.google.com/file/d/1YTIoGBgefuWg8tYUC7lUNOaeBv73lW-N/view?usp=sharing) + +## API Reference + +#### View Cypher API at : https://github.com/skt2020/cypher-api + + +## Documentation + +Cypee is a Mobile-Based Native Application that has features of a Crypto wallet and a Chat +Application. Strong and secured crypto transaction and authentication system secured with +Fireauth. It runs over a secured network called Blockchain. User data will be encrypted by the +SHA256 Algorithm. Application and User Profile secured with Two-way Authentication using +OTPs and Passwords. + +### Objective :- + +1. The main objective of this project is to propose a decentralized, secure, personalized, faster, and +efficient method of money transfer by cryptocurrency wallets using technologies like Blockchain. + +2. We are proposing a Mobile-Based native Application that has features of a Crypto Wallet and a +Strong Authentication System. + +3. Using this we can provide Secured Money Transactions and a personalized user experience with +enhanced UI. + +4. Our other objective is to improve User Experience enhance User Data Security, fraud detection, +and money trading. + +### Key Features :- + +#### User Authentication:- +1. Sandboxed Environment for the App. +2. Two-factor authentication with OTP and password. +3. Encryption of Personal Details. +#### Transaction Authorization:- +1. Transaction Authorization with Blockchain Technology. +2. Fraud detection on malicious transactions. +3. Prevention Against RDP (Remote Desktop Protocol). +#### Other Features:- +1. Payment functions, such as making a contactless payment. +2. Payment or reviewing the balance on a specific wallet account. +3. Account-to-account transfers in real-time for P2P payments. +4. Chat between the users. +5. Page-level management for admin and microsites management along with the individual themes. +6. Customer, Merchant, and Product management. + +### Cypher - High Level Architecture :- + +![image](https://user-images.githubusercontent.com/44112240/150171069-cf55c5b6-7a45-4791-bf3b-e94e33d01a8e.png) + + +### Core Devlopment technologies:- +The technologies that our team will use in the development are as illustrated below - +1. Fintech +2. Blockchain +3. Cryptography +#### Languages:- +JavaScript, Solidity, HTML, CSS +#### Libraries/Frameworks:- +1. React Native - For cross-platform mobile application development. +2. Node Js - For Backend Runtime Environment in Javascript language. +3. Web3 Js - For Decentralized Runtime Environment. +#### Tools:- +1. Expo - CLI - For easy Elemental design. +2. Figma - For wireframing and UI designing. +3. Remix - For writing Smart contracts. +4. Asana - For project management. +#### Services:- +1. Heroku - For API deployment. +2. Ethereum public network - For Contract deployment. +3. Firebase - For BAAS Services and Authentication System. + + +## Screenshots + +### Cypher Mobile app +![image](https://user-images.githubusercontent.com/44112240/150171239-8cb6ac07-3c28-4e4f-a65b-23d49c168e2b.png) +![image](https://user-images.githubusercontent.com/44112240/150171353-214d71c0-eca7-4ad3-b9b1-b5cc77132815.png) +![image](https://user-images.githubusercontent.com/44112240/150171403-016cb829-fc48-455d-81bf-c2cba9952f37.png) +![image](https://user-images.githubusercontent.com/44112240/150171454-b2da3b1c-0981-4c49-bcbc-44c224be23bd.png) +![image](https://user-images.githubusercontent.com/44112240/150171534-34a2ac47-4357-4ac2-be0d-58a19e1fd8ad.png) +![image](https://user-images.githubusercontent.com/44112240/150171622-a8150c73-ceef-4916-822a-966e6a4d08af.png) +![image](https://user-images.githubusercontent.com/44112240/150171728-ed2d3f39-fadd-4f61-89d0-375f4665345b.png) +![image](https://user-images.githubusercontent.com/44112240/150171855-a30273f4-ec9f-4de1-99d7-7a1a85a6c477.png) +![image](https://user-images.githubusercontent.com/44112240/150171995-6b0f7c4d-4d75-4b1f-a2b4-560cb5cb9821.png) + +### Cypher Website +![image](https://user-images.githubusercontent.com/44112240/150172244-792fe383-202d-439f-a392-2b3190f2347e.png) + +### Cypher Block Explorer +![image](https://user-images.githubusercontent.com/44112240/150172479-5c264a40-4924-4a19-a172-a31318d37107.png) + +## Authors + +- [Suryansh Trivedi](https://github.com/skt2020) +- [Sankalp Patel](https://github.com/sankalp360) +- [Shivansh Pratap](https://github.com/acousticclown) +- [Mohit vishwakarma](https://github.com/Mohit-Vishwakarma) +