Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mattpereira/buildfolio
Portfolio page template built with Scaffold ETH 2 that helps devs quickly deploy their own showcase
https://github.com/mattpereira/buildfolio
Last synced: about 18 hours ago
JSON representation
Portfolio page template built with Scaffold ETH 2 that helps devs quickly deploy their own showcase
- Host: GitHub
- URL: https://github.com/mattpereira/buildfolio
- Owner: MattPereira
- License: mit
- Created: 2024-01-21T04:36:27.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-21T19:20:13.000Z (8 months ago)
- Last Synced: 2024-03-21T20:30:22.321Z (8 months ago)
- Language: TypeScript
- Homepage: https://matt-pereira.vercel.app/
- Size: 8.49 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# [Buildfolio](https://matt-pereira.vercel.app)
A portfolio page starter template for web3 developers. The idea is to make it easy for builders to change a few lines of code in a configuration file and then deploy their web3 own portfolio site that they can share with employers or in hackathon group chats when looking to form teams.
See the example demo at https://matt-pereira.vercel.app/
## Features
All content on the page is controlled by the `packages/nextjs/buildfolio.config.ts` file
### Landing
- `ensName` is used to fetch ens records that are used for content of the `Landing` component
- You must set ens records for social links, avatar, and "title" for full display (see `nextjs/hooks/buildfolio/useFetchEnsRecords.ts)
- `resumeUrl` used for link in the header component
### About
- `aboutItems` is where you can edit your about section paragraphs
### Projects
- `buidlGuidlWalletAddress` is used to fetch data for your builds published on the BuidlGuidl app
- `projectItems` is used to display any other projects you want
### Experience
- `experienceItems` array controls the content displayed in this section
### Acheivements
- `achievementItems` is used to fetch all NFTs for a given NFT collection address and owner wallet address using the Alchemy NFT API
- `poapsWalletAddrss` is used to fetch POAPs for owned by a given wallet from the POAP API. You will need to request POAP API key from the protocol
## Getting Started
1. Clone repo
```
git clone https://github.com/MattPereira/Buildfolio.git
```
2. Install dependencies
```
yarn install
```
3. Set env vars as instructed by `packages/nextjs/.env.example`
4. Edit the `packages/nextjs/buildfolio.config.js` file with your own information
5. Deploy to Vercel
```
yarn vercel
```
6. Set environment variables on vercel
1. Set the `NEXT_PUBLIC_VERCEL_URL` to a value that looks like `matt-pereira.vercel.app`
2. Set the `ALCHEMY_API_KEY` to your alchemy api key
3. Set the `POAP_API_KEY` to the POAP api key you got from the protocol
## Technology Stack
- Scaffold ETH-2
- nextjs
- viem
- wagmie
- tailwind
- hardhat
- ENSjs
- Alchemy NFT API
- POAP API