Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gabrielnic/dfinity-react

Last synced: 3 months ago
JSON representation

Host: GitHub
URL: https://github.com/gabrielnic/dfinity-react
Owner: gabrielnic
Created: 2021-03-27T07:23:09.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-12-08T06:48:40.000Z (almost 2 years ago)
Last Synced: 2024-06-21T18:09:02.300Z (5 months ago)
Language: TypeScript
Size: 725 KB
Stars: 13
Watchers: 1
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-icp - gabrielnic/dfinity-react

README

[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

ReactJS Typescript Motoko Boilerplate + Authentication

Node version: v16.18.1
Updated for dfx 0.12.1 and @dfinity packages: 0.14.0

## About The Project
Boilerplate ReactJS/Typescript with authentication to a local II

![screen-capture](https://user-images.githubusercontent.com/6564200/125112118-a9bc8d00-e0de-11eb-9b6b-c17bd9d18272.gif)

## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

### Installation
1. Install Internet Identity locally from: https://github.com/dfinity/internet-identity
2. Clone the repo
```sh
git clone https://github.com/gabrielnic/dfinity-react
```
3. Install NPM packages
```sh
yarn
```
4. Start dfx
```sh
dfx start
```
5. Update `.env` with the II canister id eg: `Installing code for canister internet_identity, with the canister_id from internet-identity/.dfx/local/canister_ids.json -> local: eg: rwlgt-iiaaa-aaaaa-aaaaa-cai
`

6. Deploy
```sh
dfx deploy
```
7. Manual Deploy (replaces point 6)
```
dfx canister create --all
dfx generate
dfx build
dfx canister install --all
```

## Usage
Copy front-end canister id from .dfx/local/canister_ids.json and replace in the url below

Navigate to http://.localhost:8000/

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.