Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rarimo/rarime-app
Manage your identity credentials and Soulbound Tokens (SBTs) easily from the Rarime Dashboard.
https://github.com/rarimo/rarime-app
proof-of-humanity rarime rarimo
Last synced: about 1 month ago
JSON representation
Manage your identity credentials and Soulbound Tokens (SBTs) easily from the Rarime Dashboard.
- Host: GitHub
- URL: https://github.com/rarimo/rarime-app
- Owner: rarimo
- License: mit
- Created: 2023-12-05T09:03:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-17T13:59:42.000Z (2 months ago)
- Last Synced: 2024-10-19T19:50:01.613Z (2 months ago)
- Topics: proof-of-humanity, rarime, rarimo
- Language: TypeScript
- Homepage:
- Size: 3.82 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Rarime App
Manage your identity credentials and Soulbound Tokens (SBTs) easily from the Rarime App.
## Getting Started
### Pre-requisites
#### Environment:
- Node.JS 18 [**[Download Here]**]
- Typescript 5.2 [**[Instructions to Download]**]
## Setup
### Starting the server:
- Clone the repository to your machine
- Open the folder in a code editor of your choice
- Install dependencies:
```bash
yarn install
```
- Build the project:
```bash
yarn build
```
- Start the server (The server starts in port `5173` by default):
```bash
yarn start
```
- If the server fails due to the port being occupied, start the server in a different port:
```bash
PORT=5000 yarn start
```
## Contributing
We welcome contributions from the community! To contribute to this project, follow these steps:
1. Fork the repository.
1. Create a new branch with a descriptive name for your feature or bug fix.
1. Make your changes and commit them.
1. Push your changes to your branch on your GitHub fork.
1. Create a pull request from your branch to the `main` branch of this repository.
Please ensure your pull request adheres to the following guidelines:
- Add a clear pull request title;
- Add a comprehensive pull request description that includes the motivation behind the changes, steps needed to test them, etc;
- Update the [CHANGELOG.md] accordingly;
- Keep the codebase clean and well-documented;
- Make sure your code is properly tested;
- Reference any related issues in your pull request;
The maintainers will review your pull request and may request changes or provide feedback before merging. We appreciate your contributions!
## Changelog
For the changelog, see [CHANGELOG.md](./CHANGELOG.md).
## License
This project is under the MIT License — see the [LICENSE](./LICENSE) file for details.
[Rarimo Proof of Humanity]: https://docs.rarimo.com/use-cases/proof-of-humanity
[Download Here]: https://nodejs.org/en/download/
[Instructions to Download]: https://www.typescriptlang.org/download
[CHANGELOG.md]: ./CHANGELOG.md