Skip to content

Commit

Permalink
Merge branch 'main' of github.com:ethan0905/hackathon_merge
Browse files Browse the repository at this point in the history
  • Loading branch information
ethan0905 committed Nov 24, 2022
2 parents 601119f + 526c50c commit 8264a23
Showing 1 changed file with 50 additions and 19 deletions.
69 changes: 50 additions & 19 deletions README.md
Expand Up @@ -6,40 +6,67 @@

</div>

## 🤏 Pitch
We are 4 students from 42 school and we have been experiencing issues with our client payement (deadline, terms of contract, ...).
We thought that using blockchain technology to solve this problem was an interesting idea.

## 📔 Summary

- [❗ Problem](#-problem)
- [✅ Solution](#-solution)
- [⚙️ How to run the project ?](#%EF%B8%8F-how-to-run-the-project-)
- [📈 Business model](#-business-model)
- [🧭 Roadmap](#-roadmap)
- [🖥️ Development perspective](#%EF%B8%8F-development-perspective)
- [⚠️ License](#%EF%B8%8F-license)

## ❗ Problem
#### What problem does your project solve?
#### How does it fit into the theme "Building a Decentralized Future"?
#### What problem does your project solve?
1. Contract falsification
2. Deadline for payement not respected
3. Terms of contract not respected

#### How does it fit into the theme "Building a Decentralized Future"?
The solution is independant, self governing.

## ✅ Solution
#### How did you resolve this issue?
→ We decided to solve this issue, by creating an easy to use and decentralized payement protocol service that protect the 2 users during transaction. [...]
#### What technologies did you use?
TailwindCSS and ReactJS for frontend and backend
Starton API for the smart contracts managements
1. We decided to solve this issue, by creating an easy to use and decentralized payement protocol service that protect the 2 users during transaction (service-for-money).
2. For each mission, we create a unique smart contract that is not editable and not replicable.
3. We store the documents on decentralised database (IPFS).

We create a climate of trust for every users (Open Trust Framework Model).

#### What technologies did you use?
- Escalidraw for project diagram
- Figma to design and prototype the website
- Trello to manage the project development
- TailwindCSS and ReactJS for frontend and backend
- Starton API for the smart contracts managements
- IPFS for the decentralised datastorage

#### What was your biggest technical challenge and how does your solution solve it?
?
We never worked on Web3 before, so the biggest technical challenge was to give user the ability to write his own smart contract without knowledge.
Our solution solve it by creating a form interface that write directly into our smart contract.

## ⚙️ How to run the project ?

1. Clone the repository:
`git clone https://github.com/ethan0905/hackathon.git`

2. Run at the root of repository, the following bash commands:
`https://github.com/ethan0905/hackathon_merge.git`
2. Run at the root of repository, the following bash commands:
`docker-compose up --build`

3. Then go to the following url on internet:
`localhost:3000`

## Process
## 📈 Business model

For each contract, we take a pourcentage of the total amount (6%)

pas besoin de bcp de personnes (peu couteux)
ajout differents type de contracts -> toucher une plus grande audience

- Docker
- Metamask connection
- Figma
- Smartcontract
- npm install react-ipfs-uploader
- npm install ipfs -g (for ipfs)

## 🧭 Roadmap

- [x] Docker installation
Expand All @@ -53,5 +80,9 @@ Starton API for the smart contracts managements
- [ ] Form:
- [ ] Interaction with Smart contract at {address} on {network}

## 🖥️ Development perspective
Create a DAO,
Create our coin, the more user is holding, the less the additionnal fees gonna be

## ⚠️ License
Distributed under the MIT License. See `LICENSE.txt` for more information.

0 comments on commit 8264a23

Please sign in to comment.