Merge pull request #49 from chiscookeke11/documentation

Documentation

Author: demola234

documentation/PROJECT_DOCUMENTATION.md

@@ -0,0 +1,209 @@
+
+<a id="readme-top"></a>
+
+
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/demola234/deFICrowdFunding-Backend/test.yml)](https://github.com/DefiFundr-Labs/defifundr_backend/actions)
+![GitHub go.mod Go version (branch & subdirectory of monorepo)](https://img.shields.io/github/go-mod/go-version/demola234/deFICrowdFunding-Backend/main)
+[![GitHub issues](https://img.shields.io/github/issues/demola234/deFICrowdFunding-Backend)](https://github.com/DefiFundr-Labs/defifundr_backend/issues?q=is%3Aissue%20state%3Aopen)
+[![GitHub Repo stars](https://img.shields.io/github/stars/demola234/deFICrowdFunding-Backend)](https://github.com/DefiFundr-Labs/defifundr_backend/stargazers)
+
+
+
+<!-- PROJECT LOGO -->
+<br />
+<div align="center">
+  <a href="https://github.com/othneildrew/Best-README-Template">
+    <img src="https://avatars.githubusercontent.com/u/193694759?s=200&v=4" alt="Logo" width="80" height="80">
+  </a>
+
+  <h1 align="center">DefiFundr</h1>
+
+  <p align="center">
+    A decentralized crowdfunding platform for the Ethereum blockchain
+    <br />
+    <a href="#">View Demo</a>
+    &middot;
+    <a href="#">Report Bug</a>
+    &middot;
+    <a href="#">Request Feature</a>
+  </p>
+</div>
+
+
+
+<!-- TABLE OF CONTENTS -->
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li>
+      <a href="#about">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>
+      </ul>
+    </li>
+    <li><a href="./sub-docs/ARCHITECTURE_DOCUMENTATION.md">Architecture documentation</a></li>
+    <li><a href="./sub-docs/WEBAPP_DOCUMENTATION.md">WebApp documentation</a></li>
+    <li><a href="./sub-docs/BACKEND_DOCUMENTATION.md">Backend Documentation</a></li>
+    <li><a href="./sub-docs/MOBILE_DOCUMENTATION.md">Mobile Documentation</a></li>
+    <li><a href="./sub-docs/DEVELOPMENT_WORKFLOW.md">Development Workflow</a></li>
+  </ol>
+</details>
+
+
+
+<!-- ABOUT THE PROJECT -->
+
+
+## What is DefiFundr?
+<span id="#about"> </span>
+DefiFundr is a decentralized crowdfunding platform built on the Ethereum blockchain. It allows users to create and contribute to crowdfunding campaigns, with features including:
+
+<ul>
+<li> Campaign creation with funding goals and deadlines</li>
+<li>Fund disbursement upon successful campaigns</li>
+<li>Refund mechanism for unsuccessful campaign</li>
+
+</ul>
+
+
+
+
+
+
+
+
+<span id="#built-with" ></span>
+### Built With 
+
+
+
+
+* [![React][React.js]][React-url]
+* [![Next.js](https://img.shields.io/badge/Next.js-black?logo=next.js&logoColor=white)](#)
+* [![TailwindCSS](https://img.shields.io/badge/Tailwind%20CSS-%2338B2AC.svg?logo=tailwind-css&logoColor=white)](#)
+* [![Dart](https://img.shields.io/badge/Dart-%230175C2.svg?logo=dart&logoColor=white)](#)
+
+
+
+
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+<span id="#prerequisites" ></span>
+### Prerequisites
+
+To set up any of the repositories, you need to **fork** and **clone** them: 
+
+
+#### Backend (Go API)  
+```bash
+git clone https://github.com/DefiFundr-Labs/defifundr_backend.git
+go mod download
+```
+
+
+
+#### Mobile App
+```bash 
+git clone https://github.com/DefiFundr-Labs/defifundr_web_app.git
+npm install
+npx expo start
+```
+
+#### Web App
+```bash 
+git clone https://github.com/DefiFundr-Labs/defifundr_web_app.git
+npm install
+npm run dev  
+```
+
+
+#### Smart Contract
+```bash 
+git clone https://github.com/DefiFundr-Labs/
+npm install
+npx hardhat test
+```
+#### Wallet
+```bash 
+git clone https://github.com/DefiFundr-Labs/tron-wallet.git
+npm install
+npm run dev  
+```
+
+ 
+
+
+
+
+
+
+
+
+
+
+## Contributing
+
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+
+### Top contributors:
+
+## Mobile App Contributors
+<a href="https://github.com/DefiFundr-Labs/defifundr_mobile/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=DefiFundr-Labs/defifundr_mobile" />
+</a>
+
+
+## Backend Contributors
+<a href="https://github.com/DefiFundr-Labs/defifundr_backend/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=DefiFundr-Labs/defifundr_backend" />
+</a>
+
+## Web App Contributors
+<a href="https://github.com/DefiFundr-Labs/defifundr_web_app/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=DefiFundr-Labs/defifundr_web_app" />
+</a>
+
+## Smart Contract Contributors
+<a href="https://github.com/DefiFundr-Labs/defifundr_contract/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=DefiFundr-Labs/defifundr_contract" />
+</a>
+
+
+## Contributions are welcome! If you'd like to contribute to the DefiFundr backend, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Commit your changes.
+4. Submit a pull request.
+
+---
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
+[React-url]: https://reactjs.org/
+
+