Skip to content

fix: Update project configuration and initial setup instructions (#17) #85

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
Muneerali199 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix: Update project configuration and initial setup instructions (#17) #85

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
86 changes: 33 additions & 53 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<!-- Organization Name -->
<div align="center">

[![Static Badge](https://img.shields.io/badge/Stability_Nexus-/TODO-228B22?style=for-the-badge&labelColor=FFC517)](https://TODO.stability.nexus/)
[![Static Badge](https://img.shields.io/badge/Stability_Nexus-MiniChain-228B22?style=for-the-badge&labelColor=FFC517)](https://stability.nexus/minichain)

<!-- Correct deployed url to be added -->

Expand Down Expand Up @@ -105,9 +105,7 @@ It is encouraged that you develop an initial prototype during the application ph

## Project Maturity

TODO: In the checklist below, mark the items that have been completed and delete items that are not applicable to the current project:

* [ ] The project has a logo.
* [x] The project has a logo.
* [ ] The project has a favicon.
* [ ] The protocol:
- [ ] has been described and formally specified in a paper.
Expand All @@ -124,92 +122,75 @@ TODO: In the checklist below, mark the items that have been completed and delete
- [ ] Polygon
- [ ] BSC
- [ ] Base
* [ ] The mobile app:
- [ ] has an _About_ page containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
- [ ] is available for download as a release in this repo.
- [ ] is available in the relevant app stores.
* [ ] The web frontend:
- [ ] has proper title and metadata.
- [ ] has proper open graph metadata, to ensure that it is shown well when shared in social media (Discord, Telegram, Twitter, LinkedIn).
- [ ] has a footer, containing the Stability Nexus's logo and pointing to the social media accounts of the Stability Nexus.
- [ ] is fully static and client-side.
- [ ] is deployed to Github Pages via a Github Workflow.
- [ ] is accessible through the https://TODO:PROJECT-NAME.stability.nexus domain.
* [ ] the project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
* [x] the project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Capitalize checklist sentence start.

Line 129 starts with lowercase text; use sentence case for consistency with the rest of the checklist.

Suggested edit 
-* [x] the project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
+* [x] The project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
* [x] the project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
* [x] The project is listed in [https://stability.nexus/protocols](https://stability.nexus/protocols).
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 129, The checklist item "* [x] the project is listed in
[https://stability.nexus/protocols](https://stability.nexus/protocols)." starts
with a lowercase letter; update that checklist line in README.md so it begins
with a capital letter (e.g., change "the project is listed..." to "The project
is listed in https://stability.nexus/protocols.") to match sentence case used
elsewhere in the checklist.


---

## Tech Stack

TODO:

### Frontend

TODO:
### Backend/Core

- Next.js 14+ (React)
- TypeScript
- TailwindCSS
- shadcn/ui
- Python 3.10+
- PyNaCl (hashing, signing, verification)
- py-libp2p (peer-to-peer networking)

### Blockchain
### Development Tools

TODO:

- Wagmi
- Solidity Smart Contracts
- Ethers.js
- pytest (testing)
- Poetry (dependency management)

---

## Getting Started

### Prerequisites

TODO

- Node.js 18+
- npm/yarn/pnpm
- MetaMask or any other web3 wallet browser extension
- Python 3.10+
- pip or Poetry (package manager)
- git

### Installation

TODO

#### 1. Clone the Repository

```bash
git clone https://github.com/StabilityNexus/TODO.git
cd TODO
git clone https://github.com/StabilityNexus/MiniChain.git
cd MiniChain
```

#### 2. Install Dependencies

Using your preferred package manager:

```bash
npm install
# or
yarn install
# or
pnpm install
pip install -r requirements.txt
# or using Poetry
poetry install
```
Comment on lines +170 to 173
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai bot Apr 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== Check dependency manifests =="
fd -a '^(requirements\.txt|pyproject\.toml|poetry\.lock)$'

echo
echo "== Check app entrypoint candidates =="
fd -a '^(main\.py|__main__\.py)$'

echo
echo "== Check whether 'minichain' package/module exists for coverage target =="
fd -a '^minichain$' -t d
fd -a '^minichain\.py$' -t f

echo
echo "== Search for documented run command usage =="
rg -n -C2 --type=py '\bif __name__ == ["'\'']__main__["'\'']|\bmain\s*\('

Repository: StabilityNexus/MiniChain

Length of output: 1038

🏁 Script executed:

head -n 210 README.md | tail -n 40

Repository: StabilityNexus/MiniChain

Length of output: 898

Remove or implement Poetry support—Poetry commands documented in README have no backing configuration files.

The repository is missing pyproject.toml and poetry.lock files, making all "or using Poetry" instructions (lines 170–173, 189–193) non-functional. Users attempting poetry install or poetry run will fail. Either remove these alternate instructions or add Poetry configuration to the repository.

The pip install -r requirements.txt, pytest, pytest --cov=minichain, and python main.py commands are correctly documented and functional.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 170 - 173, The README references Poetry commands
("poetry install", "poetry run") but the repo lacks pyproject.toml and
poetry.lock so those commands fail; either remove the alternate "or using
Poetry" instructions and any other Poetry mentions (e.g., the lines around the
pytest/python invocation) or add minimal Poetry support by adding a
pyproject.toml (with project metadata, dependencies mirroring requirements.txt,
and script entry points if used) and committing poetry.lock; update README
accordingly to reflect whichever path you choose and ensure the README no longer
suggests Poetry when pyproject.toml/poetry.lock are absent.


#### 3. Run the Development Server
#### 3. Run Tests

Start the app locally:
Run the test suite to verify the implementation:

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
pytest
# or using Poetry
poetry run pytest
```

#### 4. Open your Browser
#### 4. Run the Application

Start the blockchain node locally:

Navigate to [http://localhost:3000](http://localhost:3000) to see the application.
```bash
python main.py
# or using Poetry
poetry run python main.py
```

---

Expand All @@ -220,9 +201,8 @@ We welcome contributions of all kinds! To contribute:
1. Fork the repository and create your feature branch (`git checkout -b feature/AmazingFeature`).
2. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
3. Run the development workflow commands to ensure code quality:
- `npm run format:write`
- `npm run lint:fix`
- `npm run typecheck`
- `pytest`
- `pytest --cov=minichain` (with coverage)
4. Push your branch (`git push origin feature/AmazingFeature`).
5. Open a Pull Request for review.

Expand Down
Loading