Skip to content

Commit

Permalink
feat: rename Vuethers to Tulipe
Browse files Browse the repository at this point in the history
  • Loading branch information
0Lilian committed Sep 1, 2022
1 parent bf64ef6 commit 0e82ad0
Show file tree
Hide file tree
Showing 176 changed files with 587 additions and 587 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,6 +1,6 @@
---
name: Bug report
about: Create a report to help us improving Vuethers
about: Create a report to help us improving Tulipe
title: ''
labels: ''
assignees: ''
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
@@ -1,6 +1,6 @@
---
name: Feature request
about: Suggest an idea for Vuethers
about: Suggest an idea for Tulipe
title: ''
labels: ''
assignees: ''
Expand Down
10 changes: 5 additions & 5 deletions CHANGELOG.md
@@ -1,18 +1,18 @@
# [1.2.0](https://github.com/0Lilian/vuethers/compare/v1.1.1...v1.2.0) (2022-09-01)
# [1.2.0](https://github.com/0Lilian/tulipe/compare/v1.1.1...v1.2.0) (2022-09-01)


### Bug Fixes

* Fake update ([fb3066f](https://github.com/0Lilian/vuethers/commit/fb3066f1dd8520a21d3cac970d4721358803edf5))
* Fake update ([fb3066f](https://github.com/0Lilian/tulipe/commit/fb3066f1dd8520a21d3cac970d4721358803edf5))


### Features

* remove comitizen from package, fake change in index.js to test CI/CD ([9677ed7](https://github.com/0Lilian/vuethers/commit/9677ed7c10fa9aa4c850242e03d1b17cbc47d11a))
* remove comitizen from package, fake change in index.js to test CI/CD ([9677ed7](https://github.com/0Lilian/tulipe/commit/9677ed7c10fa9aa4c850242e03d1b17cbc47d11a))

## [1.1.1](https://github.com/0Lilian/vuethers/compare/v1.1.0...v1.1.1) (2022-09-01)
## [1.1.1](https://github.com/0Lilian/tulipe/compare/v1.1.0...v1.1.1) (2022-09-01)


### Bug Fixes

* Fake update ([6ed009c](https://github.com/0Lilian/vuethers/commit/6ed009c0589cca2acde1c8e996e4c99eb2bdac73))
* Fake update ([6ed009c](https://github.com/0Lilian/tulipe/commit/6ed009c0589cca2acde1c8e996e4c99eb2bdac73))
22 changes: 11 additions & 11 deletions CONTRIBUTING.md
@@ -1,23 +1,23 @@
# How to contribute ?

## Contribute by _**testing**_ Vuethers
## Contribute by _**testing**_ Tulipe
1) Test the library's features
2) Observe a bug or an improvement that could be made
3) Report it by [creating an issue](https://github.com/0Lilian/vuethers/issues/new)
3) Report it by [creating an issue](https://github.com/0Lilian/tulipe/issues/new)

## Contribute by _**coding**_ Vuethers
## Contribute by _**coding**_ Tulipe
- If you have found a bug or a potential improvement for the library and want to code it, we would be happy to accept your PRs!
**Important :** It'd be good to talk about it beforehand to make sure that no one else is working on it. You can [open an issue](https://github.com/0Lilian/Vuethers/issues/new) for this.
**Important :** It'd be good to talk about it beforehand to make sure that no one else is working on it. You can [open an issue](https://github.com/0Lilian/Tulipe/issues/new) for this.
- If you want to code but don't know where to start :
1) Check out the issues labelled "[help wanted](https://github.com/0Lilian/vuethers/labels/help%20wanted)".
2) Check out [our roadmap](https://github.com/0Lilian/vuethers/projects/1) and choose an unassigned task
1) Check out the issues labelled "[help wanted](https://github.com/0Lilian/tulipe/labels/help%20wanted)".
2) Check out [our roadmap](https://github.com/0Lilian/tulipe/projects/1) and choose an unassigned task

**Here are the steps to contribute to the Vuethers's code :**
**Here are the steps to contribute to the Tulipe's code :**
1) Fork this repository
2) Clone your fork on your computer using `git clone https://github.com/<YourGithubName>/vuethers.git`
3) In local, navigate into the cloned folder called `vuethers/`
4) Add the Vuethers project repository as the "upstream" remote using `git remote add upstream https://github.com/0Lilian/vuethers.git`
5) Now you can easily pull the new updates on the Vuethers repository using `git pull upstream main`
2) Clone your fork on your computer using `git clone https://github.com/<YourGithubName>/tulipe.git`
3) In local, navigate into the cloned folder called `tulipe/`
4) Add the Tulipe project repository as the "upstream" remote using `git remote add upstream https://github.com/0Lilian/tulipe.git`
5) Now you can easily pull the new updates on the Tulipe repository using `git pull upstream main`
5) Apply changes in your local repository
6) Commit your changes using `git add -A` + `git commit -m "<YourChangesDescription>"`
7) Push your changes to your fork repository using `git push origin main`
Expand Down
58 changes: 29 additions & 29 deletions README.md
@@ -1,41 +1,41 @@
**<h1 align="center">Vuethers</h1>**
**<h1 align="center">Tulipe</h1>**
<div align="center">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/0Lilian/vuethers/Build,%20Commit%20&%20Publish%20Vuethers%20Packages?label=Build">
<img alt="npm" src="https://img.shields.io/npm/v/vuethers?label=Version">
<img alt="npm" src="https://img.shields.io/npm/dw/vuethers?color=%23bcf&label=Downloads">
<img alt="Libraries.io dependency status for latest release" src="https://img.shields.io/librariesio/release/npm/vuethers?color=%23faf&label=Dependencies">
<img alt="NPM" src="https://img.shields.io/npm/l/vuethers?color=def&label=License">
<img alt="GitHub file size in bytes" src="https://img.shields.io/github/size/0Lilian/vuethers/dist/vuethers.min.js?label=Raw size">
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/workflow/status/0Lilian/tulipe/Build,%20Commit%20&%20Publish%20Tulipe%20Packages?label=Build">
<img alt="npm" src="https://img.shields.io/npm/v/tulipe?label=Version">
<img alt="npm" src="https://img.shields.io/npm/dw/tulipe?color=%23bcf&label=Downloads">
<img alt="Libraries.io dependency status for latest release" src="https://img.shields.io/librariesio/release/npm/tulipe?color=%23faf&label=Dependencies">
<img alt="NPM" src="https://img.shields.io/npm/l/tulipe?color=def&label=License">
<img alt="GitHub file size in bytes" src="https://img.shields.io/github/size/0Lilian/tulipe/dist/tulipe.min.js?label=Raw size">
</div>

<h3 align="center" style="color:red">A DApp frontend framework for Vue 3 built with Ethers.js</h2>

<br/>

<p align="center">
<a href="https://vuethers.org/">
<img src="https://static.vuethers.org/vuethers-logo.png" alt="Vuethers logo">
<a href="https://tulipe.org/">
<img src="https://static.tulipe.org/tulipe-logo.png" alt="Tulipe logo">
</a>
</p>

- 馃挕 **Intuitive Design** : Vuethers abstracts a lot of repetitive and heavy tasks but has been thought to always let developers feel what happens under the hood.
- 馃挕 **Intuitive Design** : Tulipe abstracts a lot of repetitive and heavy tasks but has been thought to always let developers feel what happens under the hood.

- 馃Ε **Ready-to-use** : Vuethers comes with +20 EVM chains and +5 wallets pre-configured. Give it a chain's ID and a wallet name, and your DApp is ready to run !
- 馃Ε **Ready-to-use** : Tulipe comes with +20 EVM chains and +5 wallets pre-configured. Give it a chain's ID and a wallet name, and your DApp is ready to run !

- 馃枛 **Flexible styling** : Vuethers comes with 3 levels of styling, from unstylized to opinionated, so you can choose your level of customization.
- 馃枛 **Flexible styling** : Tulipe comes with 3 levels of styling, from unstylized to opinionated, so you can choose your level of customization.

- 馃摝 **Extremely minimal** : Vuethers weight less than 15kB gzipped and relies on only 2 top-level dependencies : Vue3 and Ethers.js
- 馃摝 **Extremely minimal** : Tulipe weight less than 15kB gzipped and relies on only 2 top-level dependencies : Vue3 and Ethers.js

<br/>

<h3 align="center">
<a href="https://vuethers.org/">Website</a>
<a href="https://tulipe.org/">Website</a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://vuethers.org/guide/welcome/introduction">Documentation</a>
<a href="https://tulipe.org/guide/welcome/introduction">Documentation</a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://vuethers.org/api/">API</a>
<a href="https://tulipe.org/api/">API</a>
&nbsp;&nbsp;|&nbsp;&nbsp;
<a href="https://vuethers.org/changelog/">Changelog</a>
<a href="https://tulipe.org/changelog/">Changelog</a>
</h3>

<br/>
Expand All @@ -52,9 +52,9 @@ Beta and stable versions should be released by the **end of 2022**.
## How does it tastes ? :yum:

### Easy configurations
Firstly, you can configure your entire DApp frontend in a single file called `vuethers.config.js`.
Firstly, you can configure your entire DApp frontend in a single file called `tulipe.config.js`.
```js
export const vuethersConfig = {
export const tulipeConfig = {
networks: [
{
id: 1,
Expand All @@ -74,15 +74,15 @@ With this minimal configuration, your DApp frontend will :
- and allows users to connect to it using the [Metamask](https://metamask.io/) wallet (`id: "metamask"`).

### The `dapp` object
Most of the things you need to built are available through the `dapp` object, which can be simply imported from the `vuethers` package.
Most of the things you need to built are available through the `dapp` object, which can be simply imported from the `tulipe` package.
```js
import { dapp } from "vuethers";
import { dapp } from "tulipe";
```

### Auto-instanciations
When your DApp loads, Vuethers will read your `vuethers.config.js` file and populates, if possible, the `dapp` object with all the `Ethers.js` instances your DApp requires.
When your DApp loads, Tulipe will read your `tulipe.config.js` file and populates, if possible, the `dapp` object with all the `Ethers.js` instances your DApp requires.
```js
import { dapp } from "vuethers";
import { dapp } from "tulipe";

dapp.provider // An Ethers.js Provider instance
dapp.signer // An Ethers.js Signer instance
Expand All @@ -98,14 +98,14 @@ You don't have anymore to deal with multiple manual instanciations.
## ARS (Automated Relations Safety)
While a DApp has a very unstable context (eg. a user can connect/deconnect a wallet, chain connection can be lost, etc.) it may be difficult to always write safe code.

Vuethers comes with ARS, an internal system that ensure that your DApp instances always remain safe to use.
Tulipe comes with ARS, an internal system that ensure that your DApp instances always remain safe to use.

For example, if the signer of your DApp has changed, all the contracts instances will be automatically updated with the new signer.

## Safers
Also, in such an unstable context, writing safe code may became quickly complex.

To help developers always writing safe code, Vuethers provides many safers methods and components.
To help developers always writing safe code, Tulipe provides many safers methods and components.

Making your code safe has never been so easy !

Expand All @@ -132,12 +132,12 @@ dapp.provider.onSafe(() => {
### Chain watchers
When developing reactive web DApps frontends we need to regularly fetch on-chain datas to always display the most up-to-date ones to the users.

Vuethers provides chain watchers to efficiently watch for mutations of an on-chain data and to run a given callback each time it occurs.
Tulipe provides chain watchers to efficiently watch for mutations of an on-chain data and to run a given callback each time it occurs.

Here is how we can track and display an always up-to-date ERC20 balance to the user :
```html
<script setup>
import { dapp } from "vuethers";
import { dapp } from "tulipe";
const userAddress = "0xf39Fd6e5..."
let userBalance = $ref(null);
Expand All @@ -154,9 +154,9 @@ dapp.contracts.MyToken.watch("balanceOf", [userAddress], (newValue) => {
```

### Final words
Vuethers offers a lot more things to makes safe DApp frontend development a real piece of cake.
Tulipe offers a lot more things to makes safe DApp frontend development a real piece of cake.

You can find them all by reading [its documentations](https://vuethers.org/).
You can find them all by reading [its documentations](https://tulipe.org/).

<br/>

Expand Down
2 changes: 1 addition & 1 deletion demo/frontend/index.html
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Vuethers Testing App</title>
<title>Tulipe Testing App</title>
</head>
<body>
<div id="app" class="ve-app">APP IS LOADING</div>
Expand Down
2 changes: 1 addition & 1 deletion demo/frontend/src/App.vue
Expand Up @@ -25,7 +25,7 @@ dapp.contracts.Lock.onReadSafe(function (cpt) {

<template>
<DebugBar/>
<h1>Vuethers Testing App</h1>
<h1>Tulipe Testing App</h1>
<OnDappSafe>
<p>{{ dapp.signer.address.value }}</p>
<template #safe>
Expand Down
6 changes: 3 additions & 3 deletions demo/frontend/src/main.js
@@ -1,10 +1,10 @@
import { createApp } from "vue"
import { initVuethers } from "../../../src/index.js"
import { initTulipe } from "../../../src/index.js"
import App from "./App.vue"
import { vuethersConfig } from "../vuethers.config.js"
import { tulipeConfig } from "../tulipe.config.js"

const app = createApp(App)

await initVuethers(app, vuethersConfig)
await initTulipe(app, tulipeConfig)

app.mount("#app")
2 changes: 1 addition & 1 deletion demo/frontend/vuethers.config.js
@@ -1,4 +1,4 @@
export const vuethersConfig = {
export const tulipeConfig = {
networks: [
{
chainId: 31337,
Expand Down
2 changes: 1 addition & 1 deletion dist/index.f79cdce2.js
@@ -1,4 +1,4 @@
import { AvailableWallets as n, ConnectWalletButton as o, ContractInteractor as c, DebugBar as l, EventInteractor as S, EventsInteractor as f, InputUnits as i, MethodInteractor as p, MethodsInteractor as s, OnContractReadSafe as O, OnContractWriteSafe as d, OnContractsReadSafe as C, OnContractsWriteSafe as I, OnDappSafe as v, OnProviderSafe as W, OnSignerSafe as m, SelectNetworkDropdown as u, Transact as D, styleLevelProp as b } from "./vuethers.es.js";
import { AvailableWallets as n, ConnectWalletButton as o, ContractInteractor as c, DebugBar as l, EventInteractor as S, EventsInteractor as f, InputUnits as i, MethodInteractor as p, MethodsInteractor as s, OnContractReadSafe as O, OnContractWriteSafe as d, OnContractsReadSafe as C, OnContractsWriteSafe as I, OnDappSafe as v, OnProviderSafe as W, OnSignerSafe as m, SelectNetworkDropdown as u, Transact as D, styleLevelProp as b } from "./tulipe.es.js";
import "vue";
import "ethers";
export {
Expand Down

0 comments on commit 0e82ad0

Please sign in to comment.