README.md

Sin City

Capstone project · Solidity/Web3 bootcamp · Encode x ETHDEmver

Table of Contents

1. About The Project
   • Built With
   • Assignment
   • Intro
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Author

About The Project

Built With

• 

• 

• 

• 

• 

• 

• 

• 

• 

• 

Assignment

Following is the essence of the assignment given:

Intro

This project includes:

• dApp - a React frontend.
• hardhat - A Node.js and solidity development environment.

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

You must be running node v. 16 or higher.

Installation

1. Clone the repo:

   git clone https://github.com/AndyOooh/sin-city

2. Install packages from the root of both projects (dApp and hardhat):

   yarn install

(back to top)

Usage

If you plan to use the hardhat environment you must rename the .env.example to .env and add your own variables. This is to prevent the environment variables from being committed to the repository.

To start teh development server, in dApp run:

yarn start

Once you have the development servers running, you can access the client at localhost:3000.

(back to top)

Roadmap

• Build DEX.
• Build Casino with roulette.
• Other games.
• Backend

See the open issues for a full list of proposed features (and known issues).

(back to top)

Author

👤 AndyOooh

• Website: andyo.xyz
• LinkedIn: @andyooh
• Resume: andyo.xyz/resume

(back to top)