NiftyTracker is an app that allows user to view their NFT portfolio, LazyMint NFT's & track wallets of interest with telegram notifications.
Major changes in this fork include:
- Complete refactoring to Typescript
- Testing
- Linting
- Precommit hooks
- Conventional commits
- More modular React components
- Bug fixes related to authentication and errors on page refreshes
Name | Description |
---|---|
Next.js | React SSR Framework |
Moralis | Web3 SDK |
Metamask | Authentication |
Redux | App store |
Husky | Enables git hooks |
Lint-staged | Run tasks on staged files |
Jest/React-testing | Testing library |
Opensea API | Used to fetch addition NFT info |
Folder | Description |
---|---|
src/pages |
Nextjs routes |
src/components |
React components |
src/helpers |
App helper functions |
src/services |
Api client |
src/state |
Redux store |
src/styles |
App css styles |
src/__tests__ |
Testing with Jest/React-testing lib |
src/ts |
Typescript types |
To set up a development environment you need to have MetaMask chrome extension installed.
To set up the Moralis SDK, you'll need a running Moralis server. Follow these steps to create one and set up the environment variables:
- Create a Moralis account.
- Once in the dashboard, create a server in the
Mainnet
. - Select the
Eth blockchain (Mainnet)
. - Once the server is created, view your server details to get the access credentials.
- Create a
.env.local
in the root of this project and add the following environment variables:NEXT_PUBLIC_APP_ID=your Moralis Application Id
NEXT_PUBLIC_SERVER_URL=your Moralis Server Url
- Install the following Moralis plugins:
- Rarible NFT Tools
- OpenSea – Buy and Sell NFTs
To start the development environment follow these steps:
- Install the dependencias by runnning
npm install
in the root of the project. - Start the development server by running
npm run dev
.
This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized:
- Make sure your shell path is in the root of the project (not inside any of the packages).
- Run
npm install
. - Stage the files you are committing with
git add [files]
. - Run
npm run commit
. This will start an interactive prompt that generates your commit message:- Select the type of change.
- Type the scope. This is either
global
for project-wide changes or one of the packages (kibbeh, shawarma etc.). - Write a short, imperative tense description of the change.
- If the above was not sufficient, you may now write a longer description of your change (otherwise press enter to leave blank).
- y or n for whether there are any breaking changes (e.g. changing the props of a component, changing the JSON structure of an API response).
- y or n for whether this change affects an open issue, if positive you will be prompted to enter the issue number.
- Your staged files will be checked for types, linting and format errors and the test suite will run. If one of these tasks fail, please review and update your code before trying to commit again.
- Your commit message has now been created, you may push to your fork and open a pull request.