Repo Restructure

Author: emmanuelJet

.github/workflows/firebase-hosting-merge.yml

@@ -6,9 +6,6 @@ name: Deploy to Firebase Hosting on merge
   push:
     branches:
       - release
-defaults:
-  run:
-    working-directory: aepp
 jobs:
   build_and_deploy:
     runs-on: ubuntu-latest

.gitignore

@@ -1,5 +1,24 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
 /node_modules
-/keep
-.aeproject-store
-.firebase
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
 .DS_Store
+.firebase
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at dev@superchat.aekiti.com. All
+reported by contacting the project team at superchat@aekiti.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

CONTRIBUTING.md

@@ -17,5 +17,5 @@ _Welcome superheroes! It is **awesome** to have you here! Before you start contr
 5. Create a new pull request from your forked repository.
 
 ## Resources
-- [AEproject](https://aeproject.gitbook.io/aeproject)
-- [Getting Started Tutorials](https://aeternity.com/documentation-hub/getting-started/hello-world-with-sophia)
+- [ReactJS](https://reactjs.org)
+- [Superhero Backend API](https://raendom-backend.z52da5wt.xyz/docs)

README.md

@@ -1,26 +1,24 @@
 # Superchat
 Superchat is an open-source Decentralized Finance(Defi) chat æpp built mainly for the Superhero.com platform at https://superchat.aekiti.com.
 
-## Inspiration
-We were inspired by the idea of building a secure chat platform, on the blockchain where tokens can be sent with minimal loss and optimum security in the form of a message.
+- [Contributing.md](./CONTRIBUTING.md)
+- [Superchat Contract Repo](https://github.com/aekiti/superchat-contract)
+- [HumanDefiHæck Project](https://devpost.com/software/superchat)
 
-## What it does
-Superchat sends AE tokens from one user to another easily as they chat with friends and family thereby reducing the loss of funds in AE tokens transfer. Superchat runs with three smart contracts that help it perform and build a solution for our inspiration. The contracts are SuperChatProfile, SuperChatFriend, and SuperChatMessage.
+## Project setup
+```bash
+npm install
+```
 
-The SuperChatProfile contract starts the authentication flow by registering a user and getting the user details. The SuperChatFriend contract connects remotely with the ProfileContract to send a friend request, accept or reject friend requests, get friend requests, and finally get each user friend list.
+### Compiles and hot-reloads for development
+```bash
+npm start
+```
 
-Lastly, the SuperchatMessage contract performs the work of sending messages and even AE tokens to friends as a message
-
-## How we built it
-Superchat is built on æternity blockchain and it uses ReactJS for its Front-End implementation.
-
-The repository contains source codes that sum up Superchat. It has its smart contracts written and tested with the AEproject tool. It has its wallet created using the AECLI tool.
-
-The react Front-End implementation uses the AEproject React shape that follows the theme and layout of the voting section of the Superhero.com platform.
-
-## What's next for Superchat
-- Implementation of the group functionalities, to enable a user to send tokens and messages to members of the created group.
-- Implementing a group saving feature to allow users to save AE tokens for some time.
+### Compiles and minifies for production
+```bash
+npm build
+```
 
 ## [License](./LICENSE)
 ```markdown
@@ -34,4 +32,6 @@ in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
+
+...
 ```