An interactive reference to Ethereum Virtual Machine Opcodes

This guide presents a comprehensive walkthrough on how to set up and contribute to the evm.codes web application. This project is powered by open-source initiatives, including EthereumJS and SolcJS.

Installation

The application requires the following dependencies:

• NodeJS = 20
• pnpm

Local Development

To set up the application for local development, follow these steps:

Clone this repository:

git clone git@github.com:smlxlevm.codes.git

Install the dependencies:

pnpm install

If you want to run the contract viewer, specify the environment variables in .env.local:

APIKEY_ETHERSCAN=

Start up the app and see it running at http://localhost:3000:

pnpm dev

Deploying

Deployments are handled automatically by Vercel as soon as your PR is merged to main.

Contributing

evm.codes is developed by a small dedicated team, and contributions are highly welcome! Here’s how to get involved:

• Check for existing GitHub issues before submitting a pull request.
• If there’s no issue, create a new one to discuss the best approach and get feedback from the team.
• When you’re ready to submit a pull request, prefix your title with either:
  • chore: for small improvements and maintenance
  • fix: for bugs and hot fixes
  • feat: for new features

Coding Conventions

The project is pre-configured with Eslint, TypeScript, and Prettier. Use the following commands to maintain coding standards:

pnpm lint --fix

pnpm typecheck

pnpm lint:package

Architecture

If you are keen to contribute, please review the architecture document to understand the structure and workings of the application.

License

This project is licensed under the MIT license.

Troubleshooting

If you encounter issues during setup or development, try these troubleshooting steps:

• Ensure you have the correct version of NodeJS and pnpm installed.
• Double-check your directory paths and environment variable names in .env.local.
• Refer to any existing GitHub issues before submitting a new one.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.