From 591877d1e976bd4e08cd331986925cbe9b3560b1 Mon Sep 17 00:00:00 2001 From: sujitaw Date: Wed, 27 May 2026 18:29:53 +0530 Subject: [PATCH] feat/update readme file Signed-off-by: sujitaw --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 50e13dc..14a4f04 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,32 @@ # platform-admin Administration Console for CREDEBL Platform Admin + +## 🚀 Quick start + +1. Clone this repository or download the ZIP file +2. Make sure that you have **Bun** installed +3. Install the project dependencies from the `package.json` file: + +```sh +bun install +``` + +1. Launch the Next.js local development server on `localhost:3000` by running the following command: + +```sh +bun run dev +``` + +You can also build the project and get the distribution files inside the `.next/` folder by running: + +```sh +bun run build +``` + +## Contributing + +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 + +[Apache License Version 2.0](https://github.com/credebl/platform/blob/main/LICENSE)