Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@celo/celo-composer
Advanced tools
@celo/celo-composer - npm Package Compare versions
Comparing version 0.0.2-alpha to 1.0.0-0
| { | ||
| "name": "@celo/celo-composer", | ||
| "version": "0.0.2-alpha", | ||
| "version": "1.0.0-0", | ||
| "description": "Get started building dApps on Celo", | ||
@@ -5,0 +5,0 @@ "repository": { |
100
README.md
@@ -0,1 +1,5 @@ | ||
| ## Hacktoberfest 2022 | ||
| Any feature improvement, major bug fix, or new dapp example added to celo-composer during the month of October for #hacktoberfest will be eligible for a 20-100 cUSD prize (based on complexity). Tag devrel@celo.org once you've submitted a PR. | ||
| <!-- TABLE OF CONTENTS --> | ||
@@ -59,18 +63,25 @@ | ||
| - Node | ||
| - Yarn | ||
| - Git | ||
| ## Installation | ||
| ## How to use Celo Composer | ||
| 1. Clone the repo | ||
| The easiest way to get started with Celo Composer is using `@celo/celo-composer`. This is a CLI tool enables you to quickly start building dApps on Celo for multiple frameworks including React, React Native (w/o Expo), Flutter and Angular. You can create the dApp using default Composer templates provided by Celo. To get started, use the following command: | ||
| ```sh | ||
| git clone https://github.com/celo-org/celo-composer | ||
| cd celo-composer | ||
| ```bash | ||
| npx @celo/celo-composer create | ||
| ``` | ||
| 2. Get testnet funds and install dependencies. | ||
| #### Output | ||
|  | ||
| - Select the framework you like and please enter. | ||
|  | ||
| - Enter the project name and the starter project will the create in present working directory. | ||
| ### Get testnet funds and install dependencies | ||
| ```sh | ||
| cd packages/hardhat | ||
| cd hardhat | ||
| yarn install | ||
@@ -80,7 +91,7 @@ npx hardhat create-account # prints a private key + account | ||
| 3. Create `packages/hardhat/.env` and paste the line containing the private key into it, so it looks something like this: | ||
| 1. Create `packages/hardhat/.env` and paste the line containing the private key into it, so it looks something like this: | ||
| `PRIVATE_KEY="0xba28d5cea192f121db5f1dd7f501532170bb7bb984c4d3747df3e251e529f77d"` | ||
| 4. Fund the account from the faucet [here](https://celo.org/developers/faucet). Once the account is funded, deploy the contracts with: | ||
| 2. Fund the account from the faucet [here](https://celo.org/developers/faucet). Once the account is funded, deploy the contracts with: | ||
@@ -91,22 +102,40 @@ ```sh | ||
| 5. In another terminal, start the frontend (React app using [Next.js](https://nextjs.org/)) | ||
| ## Supported Frameworks | ||
| Read more details about the hardhat package [here](https://github.com/celo-org/celo-composer/blob/main/packages/hardhat/README.md). | ||
| ### <u>React</u> | ||
| ```sh | ||
| cd packages/react-app | ||
| yarn install | ||
| yarn dev | ||
| ``` | ||
| - Creating examples and experiment with React for your libraries and components. | ||
| - Start the dApp with `yarn dev`/`npm run dev` and you are good to go. | ||
| - Support for Website and Progressive Web Application. | ||
| - Works with all major crypto wallet. | ||
| 6. Testing on Mobile | ||
| Check here to learn more about [Celo Composer - React](./packages/react-app/README.md) | ||
| - Get the Alfajores Testnet mobile wallet for Android and iOS [here](https://celo.org/developers/wallet). | ||
| - Serve your React app to your mobile device for testing via a tunnel. | ||
| Next.js defaults to serving your app on port 3000, so point the tunnel there: | ||
| ### <u>React Native</u> | ||
| ```sh | ||
| npx localtunnel --port 3000 | ||
| ``` | ||
| - You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code. | ||
| - Support for Android and IOS. | ||
| - Works with [Expo](https://expo.dev/) and without Expo. | ||
| - Working example app - The included example app shows how this all works together. | ||
| - Easy to use and always updated with latest dependencies. | ||
| Check here to learn more about [Celo Composer - React Native](./packages/react-native-app/README.md) | ||
| ### <u>Flutter</u> | ||
| - One command to get started - Type `flutter run` to start development in your mobile phone. | ||
| - Works with all major mobile crypto wallets. | ||
| - Support for Android, IOS (Web, Windows, and Linux coming soon). | ||
| - Working example app - The included example app shows how this all works together. | ||
| - Easy to use and always updated with latest dependencies. | ||
| Check here to learn more about [Celo Composer - Flutter](./packages/flutter-app/README.md) | ||
| ### <u>Angular</u> | ||
| - Creating examples and experiment with Angular for your libraries and components. | ||
| - Easy to setup and use. | ||
| Check here to learn more about [Celo Composer - Angular](./packages/angular-app/README.md) | ||
| ## Review | ||
@@ -117,3 +146,3 @@ | ||
| - Edit frontend in `packages/react-app/pages/index.tsx`. | ||
| - Open http://localhost:3000 to see the app. | ||
| - Open <http://localhost:3000> to see the app. | ||
@@ -156,3 +185,3 @@ You can run `yarn deploy --reset` to force re-deploy your contracts to your local development chain. | ||
| 📕 Read the docs: https://docs.soliditylang.org | ||
| 📕 Read the docs: <https://docs.soliditylang.org> | ||
@@ -172,3 +201,3 @@ - [Primitive Data Types](https://solidity-by-example.org/primitives/) | ||
| Join the Celo Discord server at https://chat.celo.org. Reach out on the dedicated repo channel [here](https://discord.com/channels/600834479145353243/941003424298856448). | ||
| Join the Celo Discord server at <https://chat.celo.org>. Reach out on the dedicated repo channel [here](https://discord.com/channels/600834479145353243/941003424298856448). | ||
@@ -212,3 +241,3 @@ <!-- ROADMAP --> | ||
| ``` | ||
| ```jsx | ||
| <Tab label="Contract Label" {...a11yProps(#)} /> | ||
@@ -219,3 +248,3 @@ ``` | ||
| ``` | ||
| ```jsx | ||
| <TabPanel value={value} index={#}> | ||
@@ -230,6 +259,2 @@ <GreeterContract contractData={contracts?.ContractName} /> | ||
| ## Troubleshooting | ||
| For M1 Mac developers who have installed nvm using brew, the server may crash. To resolve this issue, take a look here at this [solution](https://stackoverflow.com/a/67254340) | ||
| ## License | ||
@@ -240,3 +265,2 @@ | ||
| <!-- CONTACT --> | ||
| ## Contact | ||
@@ -247,8 +271,2 @@ | ||
| <!-- ACKNOWLEDGMENTS --> | ||
| ## Acknowledgments | ||
| - This repo is heavily inspired by [scaffold-eth](https://github.com/scaffold-eth/scaffold-eth). | ||
| <p align="right">(<a href="#top">back to top</a>)</p> |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by9.23%
17213
- Number of lines in readme file
- increased by7.38%
262
No dependency changes