Skip to content

Commit 2d2712c

Browse files
committed
add arch pic, contrib guide, github issue and PR temp, workflows...
Signed-off-by: wiseaidev <[email protected]>
1 parent 34655f3 commit 2d2712c

File tree

9 files changed

+190
-2
lines changed

9 files changed

+190
-2
lines changed

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: Bug
3+
about: "[Bug \U0001F41B]: Create a bug report for Moerphous."
4+
title: "[\U0001F41B Bug]: Bug Title."
5+
labels: needs triage
6+
assignees: wiseaidev
7+
8+
---
9+
10+
**👶 Getting Started**
11+
Please [search the history](https://github.com/moerphous/moerphous-server/issues) to see if an issue already exists for the same problem.
12+
- [ ] I have searched the existing issues.
13+
- [ ] I have tested the latest version.
14+
15+
**📝 Describe the bug**
16+
Please provide a summary of what this issue is all about. Thanks for contributing by creating an issue! ❤️
17+
18+
**🕹 Steps to reproduce**
19+
Please provide a link to a live example and an unambiguous set of steps to reproduce this bug. You can click the deploy button to provide a live reproduction case.
20+
21+
Link to live example:
22+
Steps:
23+
1.
24+
2.
25+
3.
26+
27+
**😯 Current behavior**
28+
A clear and concise description of what you expected to happen.
29+
30+
**🤔 Expected behavior**
31+
Describe what should happen.
32+
33+
**📸 Screenshots**
34+
If applicable, add screenshots to help explain your problem.
35+
36+
**🔦 Additional context**
37+
What are you trying to accomplish? How has this issue affected you? Providing context helps us come up with a solution that is more useful in the real world.

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: feature
3+
about: "[Feature\U0001F484]: Suggest a new idea for Brave Chat Server."
4+
title: "[\U0001F484Feature]: Feature title."
5+
labels: needs triage
6+
assignees: wiseaidev
7+
8+
---
9+
10+
**👶 Getting Started**
11+
Please [search the history](https://github.com/moerphous/moerphous-server/issues) to see if an issue already exists for the same problem.
12+
- [ ] I have searched the existing issues.
13+
- [ ] I have tested the latest version.
14+
15+
**📝 Describe the feature**
16+
Please provide a detailed explanation of what this feature is all about. Thanks for contributing by creating an issue! ❤️
17+
18+
**📸 Screenshots**
19+
Please provide screenshots of the expected feature, if applicable.
20+
21+
**🔦 Context**
22+
What are you trying to accomplish? How has the lack of this feature affected you? Providing context helps us come up with a solution that is more useful in the real world.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## What was wrong?
2+
3+
Related to #
4+
Closes #
5+
6+
## How was it fixed?
7+
8+
9+
## Todo:
10+
11+
- [ ] I have followed (at least) the [PR section of the contributing guide](https://github.com/moerphous/moerphous-server/blob/main/CONTRIBUTING.md#-pull-request-guidelines).
12+
13+
## Cute Animal Picture

.github/dependabot.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "github-actions"
9+
directory: "/"
10+
schedule:
11+
interval: "weekly"
12+
reviewers:
13+
- "wiseaidev"
14+
- package-ecosystem: "pip"
15+
directory: "/"
16+
schedule:
17+
interval: "weekly"
18+
reviewers:
19+
- "wiseaidev"
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependency Review Action
2+
#
3+
# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
4+
#
5+
# Source repository: https://github.com/actions/dependency-review-action
6+
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
7+
name: 'Dependency Review'
8+
on: [pull_request]
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
dependency-review:
15+
runs-on: ubuntu-latest
16+
steps:
17+
- name: 'Checkout Repository'
18+
uses: actions/checkout@v3
19+
- name: 'Dependency Review'
20+
uses: actions/dependency-review-action@v3

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# 🌍 Contributing.
2+
3+
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
4+
5+
## 👶 Getting Started!
6+
7+
Ready to contribute? Here's how to set up `moerphous-server` for local development.
8+
9+
1. Fork the `moerphous-server` repo on GitHub.
10+
2. Clone your fork locally:
11+
12+
```sh
13+
git clone [email protected]:your_name_here/moerphous-server.git
14+
```
15+
3. Create a virtualenv with make:
16+
17+
```sh
18+
make venv
19+
```
20+
21+
4. Activate the virtualenv:
22+
23+
```sh
24+
source .venv/bin/activate
25+
```
26+
27+
5. Install the main dependencies into the virtualenv using poetry and make. Assuming you have poetry installed, this is how you set up your fork for local development:
28+
29+
```sh
30+
make install
31+
```
32+
33+
**Note**: _This command will automatically generate a `.env` file from `.env.example`, uninstall the old version of poetry on your machine, then install latest version `1.2.2`, and install the required main dependencies._
34+
35+
6. Create a branch for local development:
36+
37+
```sh
38+
git checkout -b name-of-your-bugfix-or-feature
39+
```
40+
41+
Now you can make your changes locally.
42+
43+
7. When you're done making changes, check that your changes pass tox tests, including testing other Python versions with make:
44+
45+
```sh
46+
make test-all
47+
```
48+
49+
8. Commit your changes and push your branch to GitHub:
50+
51+
```sh
52+
git add .
53+
git commit -m "Your detailed description of your changes."
54+
git push origin name-of-your-bugfix-or-feature
55+
```
56+
57+
9. Submit a pull request through the GitHub website.
58+
59+
## 📙 Pull Request Guidelines.
60+
61+
Before you submit a pull request, check that it meets these guidelines:
62+
63+
1. The pull request should include tests, if possible.
64+
2. The pull request should work for Python 3.9.10. Check and make sure that the tests pass for all supported Python versions.
65+
66+
## 💡 Tips.
67+
68+
To run a subset of tests:
69+
70+
```sh
71+
make test
72+
make lint
73+
make coverage
74+
```
75+
76+
Thank you for helping us improve!

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@
88
[![Static typing: mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
99
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
1010
![Codeql](https://github.com/github/docs/actions/workflows/codeql.yml/badge.svg)
11-
1211
</div>
1312

13+
![architecture](./static/architecture.png)
14+
1415
A Fully Async-based backend for [Moerphous](https://github.com/moerphous/moerphous).
1516

1617
**Note**: MongoDB is being used to store only the wallet `classic_address` and its `seed` to make transactions work. This project is just a POC for an NFT marketplace backend. In the future, once deployed on the mainnet, MetaMask will be utilized to connect the wallet.
@@ -192,7 +193,7 @@ For development purposes, you can use openapi to interact with the endpoints. To
192193

193194
As you can notice, the default openapi authorization form has been customized to authenticate wallets using only an access token.
194195

195-
- Now you can interact with any endpoints that require authorization.
196+
- Now you can interact with any endpoint that require authentication.
196197

197198
![wallet info](./static/wallet-info.png)
198199

static/architecture.jpg

49.7 KB
Loading

static/architecture.png

312 KB
Loading

0 commit comments

Comments
 (0)