Skip to content

update: readme #1

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.

Sign up for GitHub

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

Open
felipe-muner wants to merge 1 commit into
base: main
Choose a base branch
from
Open

update: readme #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,34 @@
# cryptozombies
# CryptoZombies

## Overview

CryptoZombies is a blockchain-based project that utilizes **Solidity** and **TypeScript**. This project is structured as a learning or interactive platform where users can learn how to code smart contracts for blockchain applications, similar to the popular CryptoZombies tutorial.

## Features

1. **Smart Contracts**: Developed using Solidity, these contracts demonstrate core blockchain programming concepts.
2. **Testing Suite**: Includes tests written in TypeScript to verify contract functionality.
3. **Hardhat Integration**: Utilizes Hardhat for development, testing, and deployment of contracts.

## Installation

1. Clone the repository:
```bash
git clone https://github.com/leodutra/cryptozombies.git
cd cryptozombies
```

2. Clone the repository:
```bash
npm install
```

3. Clone the repository:
```bash
npx hardhat compile
```

4. Run tests:
```bash
npx hardhat test
```