-
Notifications
You must be signed in to change notification settings - Fork 67
fix: updated README with minimal setup and doc link #1365
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.
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
Krishethaa
wants to merge
2
commits into
credebl:main
Choose a base branch
from
Krishethaa:update-readme-minimal-setup
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,109 +1,62 @@ | ||
| # CREDEBL SSI Platform | ||
|
|
||
| This repository host codebase for CREDEBL SSI Platform backend. | ||
| Welcome to CREDEBL — a Linux Foundation Decentralized Trust Project. | ||
|
|
||
| ## Pre-requisites | ||
| CREDEBL is a fully open-source Decentralized Identity & Verifiable Credentials platform, designed for scalable, privacy-preserving digital ID solutions. | ||
|
|
||
| Install Docker and docker-compose | ||
| </br>See: https://docs.docker.com/engine/install/ | ||
| It is used to build the Decentralized National Digital ID for Bhutan & Papua New Guinea and Sovio.id by AYANWORKS. | ||
|
|
||
| Install Node: >= 18.17.0 | ||
| </br>See: https://nodejs.dev/en/learn/how-to-install-nodejs/ | ||
| 🔗 Learn more at [https://docs.credebl.id](https://docs.credebl.id) | ||
|
|
||
| **Install NestJS** | ||
| ```bash | ||
| npm i @nestjs/cli@latest | ||
| ``` | ||
|
|
||
| **Setup & run postgres** | ||
| Start the postgresql service using the docker: | ||
| --- | ||
|
|
||
| ```bash | ||
| docker run --name some-postgres -p 5432:5432 -e POSTGRES_PASSWORD=<secretpassword> -e POSTGRES_USER=credebl -d postgres | ||
| ``` | ||
| ## ⚙️ Minimal Setup Instructions | ||
|
|
||
| **Run prisma to generate db schema** | ||
| ### 1. Clone the Repository | ||
|
|
||
| ```bash | ||
| cd ./libs/prisma-service/prisma | ||
| npx prisma generate | ||
| npx prisma db push | ||
| ``` | ||
|
|
||
| **Seed initial data** | ||
|
|
||
| ```bash | ||
| cd ./libs/prisma-service | ||
| npx prisma db seed | ||
| ``` | ||
|
|
||
| # Install NATS Message Broker | ||
| ## Pull NATS docker image | ||
|
|
||
| NATS is used for inter-service communication. The only pre-requisite here is to install docker. | ||
|
|
||
| ``` | ||
| docker pull nats:latest | ||
| ``` | ||
| git clone https://github.com/credebl/platform.git | ||
| cd platform | ||
|
|
||
| ## Run NATS using `docker-compose` | ||
| The `docker-compose.yml` file is available in the root folder. | ||
| ### 2. Install Dependencies: | ||
|
|
||
| ``` | ||
| docker-compose up | ||
| ``` | ||
|
|
||
|
|
||
| ## Run CREDEBL Micro-services | ||
|
|
||
| ```bash | ||
| npm install | ||
| ``` | ||
|
|
||
| ## Configure environment variables in `.env` before you start the API Gateway | ||
| ### 3.Start the API Gateway (Development Mode): | ||
|
|
||
| ## Running the API Gateway app | ||
| You can optionally use the `--watch` flag during development / testing. | ||
| nest start --watch | ||
|
|
||
| ```bash | ||
| nest start [--watch] | ||
| ``` | ||
| You can optionally start individual microservices using: | ||
|
|
||
| ## Starting the individual Micro-services | ||
| nest start <service-name> --watch | ||
coderabbitai[bot] marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### e.g. for starting `organization service` micro-service run below command in a separate terminal window | ||
| 📚 Full Documentation | ||
| Find the complete setup guide, API references, architecture, and advanced configurations here: | ||
| ➡️ https://docs.credebl.id | ||
|
|
||
| ```bash | ||
| nest start organization [--watch] | ||
| ``` | ||
| 🤝 Contributing | ||
| We welcome PRs! Please read our Contribution Guide before submitting. | ||
|
|
||
| ### Likewise you can start all the micro-services one after another in separate terminal window | ||
| 🔏 DCO signing is required for all commits. | ||
|
|
||
| ```bash | ||
| nest start user [--watch] | ||
| nest start ledger [--watch] | ||
| nest start connection [--watch] | ||
| nest start issuance [--watch] | ||
| nest start verification [--watch] | ||
| nest start agent-provisioning [--watch] | ||
| nest start agent-service [--watch] | ||
| ``` | ||
|
|
||
| ## To access micro-service endpoints using the API Gateway. Navigate to | ||
| 📄 License | ||
| Apache License 2.0 | ||
|
|
||
| ``` | ||
| http://localhost:5000/api | ||
| ``` | ||
| --- | ||
|
|
||
| ## Credit | ||
| ## 🛠️ Steps After Editing README | ||
|
|
||
| The CREDEBL platform is built by AYANWORKS team. | ||
| For the core SSI capabilities, it leverages the great work from multiple open-source projects such as Hyperledger Aries, Bifold, Asker, Indy, etc. | ||
| ### ✅ STEP 1: Save the file | ||
|
|
||
| ## Contributing | ||
| Make sure you replaced the old README content with the new one shown above. | ||
|
|
||
| Pull requests are welcome! Please read our [contributions guide](https://github.com/credebl/platform/blob/main/CONTRIBUTING.md) and submit your PRs. We enforce [developer certificate of origin](https://developercertificate.org/) (DCO) commit signing — [guidance](https://github.com/apps/dco) on this is available. We also welcome issues submitted about problems you encounter in using CREDEBL. | ||
| --- | ||
|
|
||
| ## License | ||
| ### ✅ STEP 2: Add and Commit the Changes | ||
|
|
||
| [Apache License Version 2.0](https://github.com/credebl/platform/blob/main/LICENSE) | ||
| In your terminal: | ||
|
|
||
| ```bash | ||
| git add README.md | ||
| git commit -m "fix: updated README with minimal setup and doc link" | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.