Skip to content

Commit

Permalink
Updated README.md (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
Nidhicodes authored Jan 15, 2025
1 parent 04a0abe commit e46b850
Show file tree
Hide file tree
Showing 3 changed files with 110 additions and 47 deletions.
156 changes: 109 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,139 @@
# Djed-Solidity-WebDashboard
<!-- Don't delete it -->
<div id="readme-top"></div>

<!-- Organization Logo -->
<div align="center">
<img alt="Djed-Solidity WebDashboard" src="src/images/djedlogo.png" width="175">
&nbsp;
&nbsp;
</div>

&nbsp;

<!-- Project Name -->
<div align="center">
<h1>Djed-Solidity WebDashboard</h1>
</div>

&nbsp;

<!-- Project Social Handles -->
<p align="center">
<!-- X (formerly Twitter) -->
<a href="https://x.com/DjedStablecoin">
<img src="https://img.shields.io/twitter/follow/DjedStablecoin" alt="X (formerly Twitter) Badge"/>
</a>
&nbsp;&nbsp;
<!-- Discord -->
<a href="https://discord.gg/9SXM4jka">
<img src="https://img.shields.io/discord/995968619034984528?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" alt="Discord Badge"/>
</a>
&nbsp;&nbsp;
<!-- Medium -->
<a href="https://medium.com/djed-alliance">
<img src="https://img.shields.io/badge/Medium-black?style=flat&logo=medium&logoColor=white&logoSize=auto&color=black" alt="Medium Badge"/>
</a>
&nbsp;&nbsp;
<!-- LinkedIn -->
<a href="https://www.linkedin.com/company/djed-alliance/">
<img src="https://img.shields.io/badge/LinkedIn-black?style=flat&logo=LinkedIn&logoColor=blue&logoSize=auto&color=0A66C2" alt="LinkedIn Badge"/>
</a>
&nbsp;&nbsp;
</p>

&nbsp;

<!-- Project core values and objective -->
<p align="center">
<strong>
Djed is a formally verified crypto-backed autonomous stablecoin protocol. This repository contains the complete source code for a frontend application designed to facilitate user interaction with deployments of a Solidity implementation of the Djed protocol.
</strong>
</p>

Djed is a formally verified crypto-backed autonomous stablecoin protocol. To learn more, please check our **[gitbook docs](https://docs.djed.one/alliance/the-djed-alliance)**.
---

<!-- Table of Contents -->
<details>
<summary>Table of Contents</summary>
<ul>
<li><a href="#about"> ➤ About</a></li>
<li><a href="#known-deployments"> ➤ Known Deployments</a></li>
<li><a href="#installation"> ➤ Installation</a></li>
<li><a href="#usage"> ➤ Usage</a></li>
<li><a href="#contributing"> ➤ Contributing</a></li>
</ul>
</details>

<!-- Project Description (Start from here) -->

# About

Djed is a formally verified crypto-backed autonomous stablecoin protocol. This repository contains the complete source code for a frontend application designed to facilitate user interaction with deployments of a Solidity implementation of the Djed protocol.

---

This repository contains the complete source code for a frontend application designed to facilitate user interaction with deployments of a [Solidity implementation](https://github.com/DjedAlliance/Djed-Solidity) of the Djed protocol.
## Known Deployments

Known deployments of this frontend can be used at:

* [https://milkomeda-c1.djed.one](https://milkomeda-c1.djed.one)
* [https://milkomeda-c1-testnet.djed.one](https://milkomeda-c1-testnet.djed.one)
- [Milkomeda C1 - Mainnet](https://milkomeda-c1.djed.one)
- [Milkomeda C1 - Testnet](https://milkomeda-c1-testnet.djed.one)

By utilizing this frontend application, users can conveniently engage with Djed deployments and explore the functionalities provided by the smart contracts.

To run this frontend locally, follow the [Installation](#installation) and [Usage](#usage) instructions below.
---

And, please, feel welcome to [contribute](#contributing).
# Installation

## Installation
We use **nvm** to handle the Node version. If you don't use nvm, the Node version can be taken from the `.nvmrc` file.

We use [nvm](https://github.com/nvm-sh/nvm) to handle the Node version, if you don't use `nvm`, the Node version can be taken from the [.nvmrc](./.nvmrc) file.
1. **Clone the repository:**

To download the project dependencies, run:
```bash
git clone https://github.com/username/djed-solidity-web-dashboard.git
cd djed-solidity-web-dashboard
```
2. **Install Node version and dependencies:**
```bash
nvm install
npm install
```

## Usage

In the project directory, run:

```
# Usage
Start the development server:
```bash
npm start
```
Open http://localhost:3000 to view it in your browser.

This will run the app in development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will automatically reload when you make changes in the code.
You may also see any lint errors in the console.


To launch the test runner in interactive watch mode, run:

```
Run tests:
```bash
npm test
```

See React's documentation section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

To format the code to comply with the `prettier` style, run:

```
Format code with Prettier:
```bash
npm run format
```

To build the app for production to the `build` folder, run:

```
Build for production:
```bash
npm run build
```
# Contributing
We welcome contributions from the community!

This will correctly bundle React in production mode and optimize the build for the best performance.
The build is minified and the filenames include the hashes.
The app is ready to be deployed!

See React's documentation section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
1. Fork the project.
2. Create your feature branch (git checkout -b feature/AmazingFeature).
3. Commit your changes (git commit -m 'Add amazing feature').
4. Push to the branch (git push origin feature/AmazingFeature).
5. Open a pull request.
6. For major changes, please open an issue first to discuss what you'd like to change.

# 📬 Contact

## Contributing
- **Discord:** [@Stability Nexus](https://discord.gg/9SXM4jka)
- **Twitter/X:** [@DjedStablecoin](https://x.com/DjedStablecoin)
- **Medium:** [Djed-Alliance](https://medium.com/djed-alliance)
- **LinkedIn:** [Djed-Alliance](https://www.linkedin.com/company/djed-alliance/)

Contributions are always welcome!

If you would like to contribute, please join our [Discord channel](https://discord.gg/vXQ86XGSbQ) and reach out to us.

---
<div align="right"><kbd><a href="#readme-top">↑ Back to top ↑</a></kbd></div>

Thanks for reading 😊
Binary file added src/images/djedlogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/public
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

0 comments on commit e46b850

Please sign in to comment.