Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/exios66/netlify-morningstar-dev


https://github.com/exios66/netlify-morningstar-dev

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

# CW3D Dapp Boilerplate For Netlify

This boilerplate is set up to be deployed on Netlify and you can directly deploy this project by clicking the button below:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/alchemyplatform/netlify-alchemy-dapp-boilerplates)

Visit the [Live Demo here](https://alchemy-cw3d-dapp-boilerplate.netlify.app/)

## Resources
Please refer to CW3D's documentation and the following useful links for an in depth explanation of how to work with projects bootstrapped with CW3D:

- [Docs](https://docs.alchemy.com/docs/create-web3-dapp) - Everything you need to know when using CW3D
- [GitHub](https://github.com/alchemyplatform/create-web3-dapp) - look at the extensive code example or start contributing
- [Website](https://createweb3dapp.alchemy.com) - Learn more about CW3D and add components to your project
- [Templates](https://createweb3dapp.alchemy.com/#templates) - Check out the pre-built project templates
- [Components Library](https://createweb3dapp.alchemy.com/#components) - Add features directly to your project through components
- [Examples](https://github.com/alchemyplatform/create-web3-dapp-examples) - See the components implemented in a real world dapp
- [Community](https://t.me/createweb3dapp) - Meet other builders, get support, and give feedback!

## Overview

This project serves as a boilerplate for creating decentralized applications (dApps) using [Create Web3 Dapp](https://github.com/alchemyplatform/create-web3-dapp). It is preconfigured to be deployed on [Netlify](https://www.netlify.com/), providing you with a seamless way to get your dApp up and running in no time.

This boilerplate is built using [CW3D (Create Web3 Dapp)](https://github.com/alchemyplatform/create-web3-dapp), a powerful tool developed by [Alchemy](https://www.alchemy.com/) that allows developers to rapidly create and deploy dApps.

## What's Included?

This boilerplate has everything you need to start building a dapp:

- Next.js
- Wagmi Hooks
- Ethers.js
- Rainbowkit
- Alchemy SDK

## Supported Chains

The project supports all the major EVM chains:

- Ethereum
- Polygon
- Polygon zkEVM
- Arbitrum
- Optimism

## Getting Started

### Prerequisites

To get started with this boilerplate, you'll need to have the following software installed on your local machine:

- [Node.js](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
- [Git](https://git-scm.com/)

### Installation

1. Clone the repository to your local machine:
```
git clone https://github.com/alchemyplatform/netlify-alchemy-dapp-boilerplates.git
```
2. Navigate to the project directory:
```
cd netlify-alchemy-dapp-boilerplates
```
3. Install the required dependencies:
```
yarn install
```

### Running the Project

1. Start the local development server:
```
yarn run dev
```
2. Open your browser and navigate to [`http://localhost:3000/`](http://localhost:3000/) to view the dApp in action.

### Deploying to Netlify

This boilerplate is set up to be deployed on Netlify and you can directly deploy this project by clicking the button below:

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/alchemyplatform/netlify-alchemy-dapp-boilerplates)

If you prefer to deploy it manually, you can follow these steps:

1. Sign up for a Netlify account at [netlify.com](https://www.netlify.com/) if you don't already have one.
2. Install the Netlify CLI:
```
npm install -g netlify-cli
```
3. Run the following command to deploy your dApp to Netlify:
```
netlify deploy
```
4. Follow the prompts and provide the required information. Your dApp will be deployed and accessible via a unique URL.

## Project Structure

The boilerplate project is a Next.js application with the following structure:

```
📦root
┣ 📂components
┃ ┣ 📂navigation
┃ ┃ ┗ 📜navbar.jsx
┃ ┗ 📜InstructionsComponent.jsx
┣ 📂layout
┃ ┗ 📜mainLayout.jsx
┣ 📂pages
┃ ┣ 📜_app.js
┃ ┗ 📜index.jsx
┣ 📂public
┃ ┗ 📜cw3d-logo.png
┣ 📂styles
┃ ┣ 📜Home.module.css
┃ ┣ 📜InstructionsComponent.module.css
┃ ┣ 📜Navbar.module.css
┃ ┗ 📜globals.css
┣ 📜.gitignore
┣ 📜README.md
┣ 📜next.config.js
┣ 📜package-lock.json
┗ 📜package.json
```

Start editing the `pages/index.jsx` file to customize the project according to your own needs!