Skip to content

feat: update readme file #23

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
sujitaw wants to merge 1 commit into
base: main
Choose a base branch
from
+30 −0
Open

feat: update readme file #23

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
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)