Merge pull request #77 from MLH-Fellowship/staging

Pushing Staging Code to Main ( For Production )

.github/workflows/deployment.yml

@@ -0,0 +1,39 @@
+name: Deployment
+on:
+  push:
+    branches:
+      - main
+      - staging
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.19.0]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Deploy
+      run: |
+        git config --global user.name $user_name
+        git config --global user.email $user_email
+        git remote set-url origin https://${github_token}@github.com/${repository}
+        npm run deploy
+      env:
+        CI: false
+        user_name: 'github-actions[bot]'
+        user_email: 'github-actions[bot]@users.noreply.github.com'
+        github_token: ${{ secrets.ACTIONS_DEPLOY_ACCESS_TOKEN }}
+        repository: ${{ github.repository }}

.github/workflows/integration.yml

@@ -0,0 +1,28 @@
+name: Continuous Integration
+on: [pull_request]
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [12.19.0]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    - name: Set up Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+
+    - name: Install dependencies
+      run: npm install
+
+    - name: Build
+      run: npm run build
+      env:
+        CI: false
+

.gitignore

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

CNAME

@@ -0,0 +1 @@
+cryptodrive.tech

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 CryptoDrive
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,8 +1,143 @@
-# Explorer Template
+<!-- PROJECT LOGO -->
+<p align="center">
+  <a href="https://github.com/MLH-Fellowship/CryptoDrive">
+    <img src="./docs/assets/cd.png" height="250px"  />
+  </a>
 
-This is a template to help you get started with your projects. Find out more information inside of the Fellow Handbook.
+  <p align="center">
+    "A Decentralised Encrypted File Storing and Sharing App which is back-boned by Ethereum Smart Contracts and is preparing its launch to the moon 🚀"
+    <br /><br />
+    <a href="https://mlh-fellowship.github.io/CryptoDrive/"><strong>Browse CryptoDrive</strong></a>
+    <br />
+    <br />
+    <a href="https://en.wikipedia.org/wiki/Decentralization">What is Decentralization</a>
+    ·
+    <a href="https://mlh-fellowship.github.io/CryptoDrive/">Live</a>
+    .
+    <a href="https://github.com/MLH-Fellowship/CryptoDrive/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/MLH-Fellowship/CryptoDrive/issues">Request Feature</a>
+  </p>
+</p>
+<center>
 
-This template has a `main` and `staging` branch already setup. 
+[![Continuous Integration](https://github.com/MLH-Fellowship/CryptoDrive/actions/workflows/integration.yml/badge.svg?branch=staging)](https://github.com/MLH-Fellowship/CryptoDrive/actions/workflows/integration.yml)&nbsp;&nbsp;[![Deployment](https://github.com/MLH-Fellowship/CryptoDrive/actions/workflows/deployment.yml/badge.svg)](https://github.com/MLH-Fellowship/CryptoDrive/actions/workflows/deployment.yml) </center>
 
-- Code will only be merged into `main` once your Pod Leader has reviewed your code. 
-- During the week, you'll merge code into `staging`. 
+<!-- TABLE OF CONTENTS -->
+
+## Table of Contents
+
+- [About the Project](#about-the-project)
+  - [Usage Guidelines](#usage-guidelines)
+  - [Built With](#built-with)
+- [Project Architecture](#project-architecture)
+- [Getting Started](#getting-started-as-contributor)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Roadmap](#roadmap)
+- [IRC and Conversations](#irc-and-conversations)
+- [Contact](#admins)
+
+
+
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+A Decentralised Encrypted File Storing and Sharing App which is back-boned by Ethereum Smart Contracts. 
+<br/>
+Make sure, you have [Metamask](https://metamask.io/download.html) extension installed on your browser.
+<br/>
+You can  use it live here: <a href="https://mlh-fellowship.github.io/CryptoDrive">CryptoDrive</a>
+
+
+
+<!-- Extensions Required -->
+### Usage Guidelines.
+
+To use CryptoDrive ,<strong> Metamask </strong> browser extension is required. You can download it for [Chrome](https://chrome.google.com/webstore/detail/metamask/nkbihfbeogaeaoehlefnkodbefgpgknn?hl=en), [Firefox](https://addons.mozilla.org/en-US/firefox/addon/ether-metamask/), [Brave](https://chrome.google.com/webstore/detail/metamask/nkbihfbeogaeaoehlefnkodbefgpgknn?hl=en), [Edge](https://microsoftedge.microsoft.com/addons/detail/metamask/ejbalbakoplchlghecdalmeeeajnimhm?hl=en-US) 
+
+
+
+### Built With
+
+- [IPFS](https://ipfs.io/)
+- [Infura](https://infura.io/)
+- [Solidity](https://docs.soliditylang.org/en/v0.8.3/)
+- [React](https://reactjs.org/)
+- [Ethereum Smart Contracts](https://www.investopedia.com/terms/s/smart-contracts.asp)
+
+
+
+<!-- Project Breakdown -->
+## Project Architecture 
+
+```js
+Architecture and Figma need to be added here
+```
+
+<!-- GETTING STARTED -->
+
+## Getting Started as Contributor
+
+To get a local copy up and running follow these simple steps.
+
+### Prerequisites
+
+This is an example of how to list things you need to use the software and how to install them.
+
+- npm
+
+```sh
+npm install npm@latest -g
+```
+
+### Installation
+
+1. Clone the repo
+
+```sh
+git clone https://github.com/MLH-Fellowship/CryptoDrive.git
+```
+
+2. Install NPM packages
+
+```sh
+npm install
+```
+3. Run Locally
+
+```sh
+npm run start
+```
+<!-- ROADMAP -->
+
+## Roadmap
+
+See the [open issues](https://github.com/MLH-Fellowship/CryptoDrive/issues) for a list of proposed features (and known issues).
+
+<!-- CONTRIBUTING -->
+
+## IRC and Conversations
+
+- We recommend Blockchain beginners, to go through tutorials by CryptoZombies and Dapp University
+If you are familiar with blockchain 
+
+- For front-end we are using ReactJS at core, you need to have a decent proficiency in React to contribute to the project.
+- For queries and other conversations. Join us on Discord.
+
+```
+Will Put Discord Link Here
+```
+
+## Admins
+Important decisions regarding the project are taken by the following maintainer.
+
+| Kamesh  | Abir  | Sameer  |
+|---|---|---|
+| <img  height="100" width="100" src="https://avatars.githubusercontent.com/u/46109386?v=4">     | <img  height="100" width="100" src="https://avatars3.githubusercontent.com/u/53480076?s=460&u=c1aad58f1a773750a47475682afa80ac3b74f583&v=4">  | <img  height="100" width="100" src="https://avatars.githubusercontent.com/u/40424087?v=4"> |
+| [@ksdkamesh99](https://github.com/ksdkamesh99)  | [@imabp](https://github.com/imabp/)     | [@Sameerkash](https://github.com/Sameerkash)  |
+
+
+## Deployment
+<a href="https://mlh-fellowship.github.io/CryptoDrive/"><img src="https://img.shields.io/badge/-GitHub%20Pages-black?style=for-the-badge&logo=github"/></a>