-
Notifications
You must be signed in to change notification settings - Fork 27
Upgrade to new contracts, general improvements, and refactoring #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
3d74bde
Update docs and usage
sheIby 550caa3
Rewrite
sheIby 0499c47
Add back original information
sheIby fe625c9
Fix return statements
sheIby e001795
Unwrap fragment
sheIby 4946472
Replace tags with css
sheIby 68ff534
Use const
sheIby 74a779c
Move to utils
sheIby 95cf5d6
Add external links
sheIby 133e638
Integrate back explore possibilities
sheIby File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| # Request review from the best fit approvers group for this repo. | ||
| * @ArtBlocks/Eng-Approvers-Frontend | ||
| * @ArtBlocks/Eng-Approvers-Frontend |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,77 @@ | ||
| # artblocks-engine-react | ||
| # Art Blocks Engine (React Template) | ||
|
|
||
| This project is meant ot be used as a template to build Art Blocks Engine web apps. | ||
| It contains all of the pages and views necessary for users to browse projects, tokens and be able to purchase mints. | ||
| This project is meant to be used as a template to build Art Blocks Engine web apps. It contains all of the pages and views necessary for users to browse projects, tokens and be able to purchase mints. This repository serves as a prototype or template. It assumes your core contract is `GenArt721CoreV3` and your minting contract is `MinterDAExpV2` with all sales priced in ETH. It is NOT intended for production use. Please modify for your needs and test extensively before using. Absolutely no warranty of any kind is provided. Please review from The MIT License: | ||
|
|
||
| ## Quick Start | ||
| ## Warning | ||
|
|
||
| Run `npm install` or `yarn` to install dependencies. | ||
| **THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE.** | ||
|
|
||
| You will need to create a `.env` configuration file. You can get started by copying `sample.env` and renaming it as `.env` | ||
| # Quick Start | ||
|
|
||
| You will need a JSON RPC provider URL. | ||
| For instance, you could use infura: `https://mainnet.infura.io/v3/<API_KEY>` | ||
| You will need to set up JSON RPC urls for each chain you need to support. | ||
| Run `npm install` or `yarn` to install dependencies. | ||
|
|
||
| You can find the chains configuration in `src/utils/chains.ts` | ||
| You will need to create a `.env` configuration file. You can get started by copying `sample.env` and renaming it as `.env`. | ||
|
|
||
| Run `npm start` or `yarn start` to run the project. | ||
|
|
||
| After making any changes to the `.env` file, you will need to restart the app. | ||
|
|
||
| ## Customizing your configuration | ||
|
|
||
| In order to customize `abengine-react` for your specific Art Blocks Engine implementation, you will need to edit the default configuration provided on the `sample.env` file. | ||
|
|
||
| First of all, you will need to replace the contract addresses with your own. | ||
|
|
||
| You will also need to change the expected `chainId`, graph ql urls and possibly others, to set up `development` or `staging` environments on `testnet` if you wish to do so. | ||
| In order to customize your specific implementation, you will need to edit the default configuration provided on the `sample.env` file. First of all, you will need to replace the contract addresses with your own. | ||
|
|
||
| There are additional configuration values you could customize like the number of projects per page, or tokens per page. You will find those parameters in `src/config.ts` | ||
| You must specify an API key from [Infura](https://www.infura.io/) as well as a chain id in your environment file. Use `1` for mainnet or `5` for goerli. Alternative providers can be used by modifying the `src/components/Providers.tsx` file. Use multiple `.env` fiels to set up `development` or `staging` environments on `testnet` if you wish to do so. | ||
|
|
||
| ## Chains configuration | ||
|
|
||
| By default, `artblocks-engine-react` supports Ethereum Mainnet, Ropsten and Goerli. | ||
|
|
||
| ____ | ||
| There are additional configuration values you could customize like the number of projects per page, or tokens per page. You will find those parameters in `src/config.ts`. | ||
|
|
||
| # Sections and Features | ||
|
|
||
| This project includes wallet connection with Metamask, Wallet Connect and coinbase Wallet, implemented using [web3-react](https://github.com/Uniswap/web3-react) | ||
| This project includes wallet connection with [RainbowKit](https://www.rainbowkit.com/) and [wagmi.js](https://wagmi.sh/). | ||
|
|
||
| In addition, there are different sections described below: | ||
| ## Lander | ||
| - An empty landing page | ||
|
|
||
| ## Main (Home Page) | ||
| The main page includes the following features: | ||
| ## Projects | ||
| - Header/subheader | ||
| - Hero area with most recent project featured | ||
| - Title/artist name/description blurb | ||
| - Masonry grid of recent projects (max n = 6) | ||
| - Masonry grid of recent projects | ||
|
|
||
| ## Project | ||
| Features: | ||
| - Breadcrumb nav | ||
| - Status/date launched | ||
| - Cover image w/ links to live & img views | ||
| - Cover image | ||
| - Link to token shown as cover | ||
| - Title/artist name/# minted | ||
| - Title/artist | ||
| - Number of invocations | ||
| - Mint button | ||
| - Description | ||
| - License/library | ||
| - Artist link/OS link | ||
| - Display notes (optional field) | ||
| - Code notes (optional field) | ||
| - Masonry token grid | ||
| - Sort (by: Newest/oldest) | ||
| - Masonry token grid | ||
| - Sort (by date) | ||
| - Pagination | ||
|
|
||
| ## Token | ||
| Features: | ||
| - Breadcrumb nav | ||
| - Date minted | ||
| - Token cover img w/ links to live & img views | ||
| - Owned by: wallet/eth address | ||
| - Token cover img with links to live/static views | ||
| - Owned by address or ens | ||
| - Title/artist name | ||
| - Features table | ||
| - Etherscan link/OS link | ||
| - Etherscan and OpenSea links | ||
|
|
||
| ## Project list | ||
| Features: | ||
| - Masonry grid of projects | ||
| - Cover images | ||
| - Link to token shown as cover | ||
| - Title/artist name | ||
| - Description blurb (ellipses after n chars/words) | ||
| - Pagination | ||
|
|
||
| - Description blurb | ||
| - Pagination | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.