Updated the readme to a good template

.github/workflows/ci.yml

@@ -0,0 +1,60 @@
+name: Hardhat and Node.js CI
+
+on:
+  push:
+    branches: ["main"]
+
+  pull_request:
+    branches: ["main"]
+
+  # Can be called by another workflow
+  workflow_call:
+  # Allows you to run this workflow manually from the Actions tab (only runs on the default branch)
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - name: Check Client Lock File
+        run: ls -la ./code/
+
+      - name: Install Client Dependencies
+        run: npm install
+        working-directory: ./code/
+
+      - name: Check Client Lock File
+        run: ls -la ./code/services/ethereum/
+
+      - name: Install Services Dependencies
+        run: npm install
+        working-directory: ./code/services/ethereum/
+
+      - name: Build code directory
+        run: npm run build --if-present
+        working-directory: ./code/
+
+      - name: Test Service Functions and Contracts
+        run: npx hardhat test
+        working-directory: ./code/services/ethereum/

.github/workflows/cl.yml

@@ -0,0 +1,26 @@
+name: LaTeX Build
+
+on:
+  push:
+    branches:
+      - prototype
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Copy assets
+        run: cp -r ./docs/final-report/assets/* ./docs/final-report
+
+      - name: Compile LaTeX
+        uses: xu-cheng/latex-action@v3
+        with:
+          root_file: report.tex 
+          working_directory: ./docs/final-report
+          extra_system_packages: "inkscape"
+

.gitignore

@@ -5,7 +5,35 @@
 *.log
 *.out
 *.synctex.gz
+*.bbl
+*.blg
+*.lof
+*.lot
+*.toc
+*.alg
+*.acr
+*.ist
+*.gls
+*.glsdefs
+*.acn
+*.acr
+*.glg
+*.glo
+*.synctex(busy)
 
 # Mac OS ignored files
 *.DS_Store
-*.idea
+*.idea
+
+# File for personal notes
+notes.md
+
+# Webstorm
+
+.idea
+
+# Expo files
+.expo
+
+# Ignore the directory of wiki
+DiGo-certify-app.wiki/

README.md

@@ -1 +1,200 @@
-# DiGo-Certify-app
+# `DiGo Certify`
+
+<a name="readme-top"></a>
+
+[![Contributors][contributors-shield]][contributors-url]
+![GitHub repo size](https://img.shields.io/github/repo-size/DiGo-Certify/DiGo-certify-app)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/DiGo-Certify/DiGo-certify-app/cl.yml)
+![GitHub License](https://img.shields.io/github/license/DiGo-Certify/DiGo-certify-app)
+
+---
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/DiGo-Certify/DiGo-certify-app/blob/main/docs/images/logo.png">
+    <img src="docs/images/splash-screen.png" alt="Logo">
+  </a>
+
+<h3 align="center">SCAR: A Blockchain based approach for academic registry</h3>
+
+  <p align="center">
+    Academic certificates registry on blockchain for secure and tamper-proof verification.
+    <br />
+    <a href="https://github.com/DiGo-Certify/DiGo-certify-app/wiki"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://www.youtube.com/watch?v=4c9EznTLqlo&ab_channel=DiogoRodrigues">View Demo</a>
+    ·
+    <a href="https://github.com/DiGo-Certify/DiGo-certify-app/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/DiGo-Certify/DiGo-certify-app/issues">Request Feature</a>
+  </p>
+</div>
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about-the-project">About The Project</a>
+      <ul>
+        <li><a href="#built-with">Built With</a></li>
+      </ul>
+    </li>
+    <li>
+      <a href="#getting-started">Getting Started</a>
+      <ul>
+        <li><a href="#prerequisites">Prerequisites</a></li>
+        <li><a href="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#usage">Usage</a></li>
+    <li><a href="#license">License</a></li>
+    <li><a href="#contact">Contact</a></li>
+    <li><a href="#acknowledgments">Acknowledgments</a></li>
+  </ol>
+</details>
+
+<!-- ABOUT THE PROJECT -->
+
+## About The Project
+
+[![Block Chain and Smart Contracts][product-screenshot]][product-screenshot]
+
+SCAR, **S**mart **C**ontract **A**cademic **R**egistry is a multiplatform application that allows a entity to register academic certificates on a blockchain, and allows a third party to verify the authenticity of the certificate.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+# 🧰 `Built With`
+
+  [![Node][Node.js]][Node-url]
+
+  [![React Native][ReactNative.js]][ReactNative-url]
+
+  [![Expo React Native][Expo.js]][Expo-url]
+
+  [![Smart Contract][Solidity.sol]][Solidity-url]
+
+  [![Hardhat][Hardhat.js]][Hardhat-url]
+
+  [![Ethereum][Ethereum.js]][Ethereum-url]
+
+  [![Javasript][Javascript.js]][Javascript-url]
+
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- Star Us -->
+# ⭐️ `Star us`
+
+If you like this project, don't forget to give it a star on GitHub! Every star make us very happy and we will be very grateful to you!
+
+<!-- GETTING STARTED -->
+
+# 🚀 `Getting Started`
+
+We need to install the DiGo Certify app on your device.
+The following instructions will guide you through the installation process.
+
+## 📋 Prerequisites
+
+1. You need to have node to run the application.
+
+    [![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)](https://nodejs.org/en)
+
+2. Install npm globally on your machine:
+  ```sh
+  npm install npm@latest -g
+  ```
+
+3. Install Expo Go on your smart phone:
+
+    [![App Store](https://img.shields.io/badge/App_Store-0D96F6?style=for-the-badge&logo=app-store&logoColor=white)](https://apps.apple.com/us/app/expo-go/id982107779)
+    [![Play Store](https://img.shields.io/badge/Google_Play-414141?style=for-the-badge&logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=host.exp.exponent&hl=en)
+
+4. Install a wallet provider application, such as Metamask, on your smart phone:
+
+    [![App Store](https://img.shields.io/badge/App_Store-0D96F6?style=for-the-badge&logo=app-store&logoColor=white)](https://apps.apple.com/us/app/metamask/id1438144202)
+    [![Play Store](https://img.shields.io/badge/Google_Play-414141?style=for-the-badge&logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=io.metamask&hl=en)
+
+## 🛠️ Installation and Usage
+
+📄 Clone or fork `DiGo Certify App`:
+   ```sh
+   git clone https://github.com/DiGo-Certify/DiGo-certify-app.git && \
+   cd DiGo-certify-app/
+   ```
+📦 Install All Dependencies And Deploy the initial smart contracts onto the blockchain:
+   ```sh
+    ./install.sh
+   ```
+🚴‍♂️ Run the app
+   ```sh
+    npx expo start
+   ```
+📱 Scan the QR Code provided with your smart phone to run the app
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- USAGE EXAMPLES -->
+
+<!-- ## Usage
+
+Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
+
+_For more examples, please refer to the [Documentation](https://example.com)_
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
+
+<!-- LICENSE -->
+
+# 📜 `License`
+
+Distributed under the GNU GENERAL PUBLIC LICENSE License. See `LICENSE.txt` for more information.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- CONTACT -->
+
+# 📬 `Contact Us`
+
+:inbox_tray: Diogo Rodrigues(developer) - [[email protected]](mailto:[email protected])
+
+:inbox_tray: Gonçalo Frutuoso(developer) - [[email protected]](mailto:[email protected])
+
+:inbox_tray: Cátia Vaz(supervisor) - [[email protected]](mailto:[email protected])
+
+:inbox_tray: Alexandre Francisco(supervisor) - [[email protected]](mailto:[email protected])
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- ACKNOWLEDGMENTS -->
+
+<!-- ## Acknowledgments
+
+- []()
+- []()
+- []() -->
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+<!-- MARKDOWN LINKS & IMAGES -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/DiGo-Certify/DiGo-certify-app.svg
+[contributors-url]: https://github.com/DiGo-Certify/DiGo-certify-app/graphs/contributors
+[product-screenshot]: ./docs/images/blockchain-and-smart-contract-image.png
+[Node.js]: https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white
+[Node-url]: https://nodejs.org/
+[Expo.js]: https://img.shields.io/badge/expo-1C1E24?style=for-the-badge&logo=expo&logoColor=#D04A37
+[Expo-url]: https://docs.expo.dev/
+[Solidity.sol]: https://img.shields.io/badge/solidity-363636?style=for-the-badge&logo=solidity&logoColor=white
+[Solidity-url]: https://docs.soliditylang.org/en/v0.8.7/
+[Hardhat.js]: https://img.shields.io/badge/hardhat-000000?style=for-the-badge&logo=hardhat&logoColor=white
+[Hardhat-url]: https://hardhat.org/
+[Ethereum.js]: https://img.shields.io/badge/ethereum-3C3C3D?style=for-the-badge&logo=ethereum&logoColor=white
+[Ethereum-url]: https://ethereum.org/en/
+[Javascript-url]: https://developer.mozilla.org/en-US/docs/Web/JavaScript
+[Javascript.js]: https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&Color=yellow
+[ReactNative.js]: https://img.shields.io/badge/react_native-%2320232a.svg?style=for-the-badge&logo=react&logoColor=#fddb3c
+[ReactNative-url]: https://reactnative.dev/

code/.eslintrc.json

@@ -0,0 +1,17 @@
+{
+  "env": {
+    "browser": true,
+    "es2021": true
+  },
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  },
+  "rules": {
+    "indent": ["error", 2],
+    "linebreak-style": ["error", "unix"],
+    "quotes": ["error", "double"],
+    "semi": ["error", "always"]
+  }
+}

code/.gitignore

@@ -0,0 +1,35 @@
+# Learn more https://docs.github.com/en/get-started/getting-started-with-git/ignoring-files
+
+# dependencies
+node_modules/
+
+# Expo
+.expo/
+dist/
+web-build/
+
+# Native
+*.orig.*
+*.jks
+*.p8
+*.p12
+*.key
+*.mobileprovision
+
+# Metro
+.metro-health-check*
+
+# debug
+npm-debug.*
+yarn-debug.*
+yarn-error.*
+
+# macOS
+.DS_Store
+*.pem
+
+# local env files
+.env*.local
+
+# typescript
+*.tsbuildinfo

code/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "arrowParens": "avoid",
+  "endOfLine": "lf",
+  "semi": true,
+  "printWidth": 120,
+  "singleQuote": true,
+  "tabWidth": 4,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "htmlWhitespaceSensitivity": "ignore"
+}