Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NikhilRaikwar authored Sep 22, 2024
1 parent c24e9e8 commit 83a1f7c
Showing 1 changed file with 57 additions and 8 deletions.
65 changes: 57 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,59 @@
# build-social-media-dapp-on-core
# SocialDApp

## Contract Deployment
A Web3-based community platform for passionate builders to share their journey and connect with like-minded individuals.

- Fork and clone the repo
- Navigate into the folder using `cd build-social-media-dapp-on-core`.
- Install dependencies by running `npm install`.
- Create **.env** file and place your Private Key inside it.
- Run `npx hardhat compile` to compile.
- Run `npx hardhat ignition deploy ./ignition/modules/deploy.js --network core_testnet`to deploy.
## Technologies Used

* **Frontend**: React
* **Web3 Library**: Web3.js
* **Wallet Integration**: MetaMask

## Getting Started

### Prerequisites

* Node.js (version 14 or higher)
* npm (version 6 or higher)
* MetaMask browser extension

### Running the App

1. Clone the repository: `git clone https://github.com/your-username/socialdapp.git`
2. Install dependencies: `npm install` or `yarn install`
3. Create a `.env` file with your private key (e.g. `PRIVATE_KEY=0x123456...`)
4. Start the app: `npm start` or `yarn start`
5. Open the app in your browser: `http://localhost:3000`

### Connecting to MetaMask

1. Click on the "Connect MetaMask" button
2. Select the MetaMask account you want to connect
3. Approve the connection request

## Project Structure

* `src/`: Source code for the app
+ `components/`: React components
+ `contexts/`: Contexts for the app (e.g. Web3Context)
+ `images/`: Images used in the app
+ `index.js`: Entry point for the app
* `public/`: Publicly accessible files
+ `index.html`: HTML file for the app

## Available Scripts

* `npm start`: Starts the app in development mode
* `npm run build`: Builds the app for production
* `npm run deploy`: Deploys the app to a production environment

## Contributing

Contributions are welcome! If you'd like to contribute to SocialDApp, please fork the repository and submit a pull request.

## License

This project is licensed under the MIT License.

## Authors

* Nikhil Raikwar

0 comments on commit 83a1f7c

Please sign in to comment.