.-. .-..-. .-.  ,--,  ,-.    ,---.  .-. .-.   .---.
 |  \| || | | |.' .')  | |    | .-'  | | | |  ( .-._)
 |   | || | | ||  |(_) | |    | `-.  | | | | (_) \
 | |\  || | | |\  \    | |    | .-'  | | | | _  \ \
 | | |)|| `-')| \  `-. | `--. |  `--.| `-')|( `-'  )
 /(  (_)`---(_)  \____\|( __.'/( __.'`---(_) `----'
(__)                   (_)   (__)

Nucleus App

This is a Next.js project bootstrapped with create-next-app.

Environment Setup

To set up the environment variables, copy the .env.example file to .env:

cp .env.example .env

For development, you will need a Wallet Connect project ID and a Tenderly RPC URL (which an admin can provide).

Node.js Version

Ensure you have Node.js version 20.12.2 or greater installed. You can check your Node.js version with:

node -v

Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

Contributing

To contribute, please follow these steps:

1. Fork the repository: Click the "Fork" button at the top of this repository to create your own copy.

2. Clone your fork: Clone your forked repository to your local machine.

   git clone https://github.com/your-username/nucleus-app.git

Code Structure

• Pages: The pages directory contains the application's routes.
• Components: Reusable UI components are located in the components directory.
• Store: The Redux store configuration and slices are in the store directory.
• Config: Configuration files for various services and settings are in the config directory.
• Styles: Global styles and theme configurations are in the styles directory.

Environment Variables

Make sure to set the following environment variables in your .env file:

• NEXT_PUBLIC_FUNKIT_API_KEY: Your Funkit API key.
• TENDERLY_RPC_URL: The RPC URL for Tenderly.
• WALLET_CONNECT_PROJECT_ID: Your Wallet Connect project ID.

Additional Resources

• Sentry: This application uses Sentry for error tracking. Configuration files for Sentry can be found in the root directory.
• Chakra UI: The application uses Chakra UI for styling and components. Refer to the Chakra UI documentation for more information.
• Redux: The application uses Redux for state management, providing a predictable state container for JavaScript applications.