https://github.com/robin-thomas/phi
https://github.com/robin-thomas/phi
ceramic dapp ethereum ipfs nextjs react textileio web3
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/robin-thomas/phi
- Owner: robin-thomas
- License: mit
- Created: 2021-10-25T07:52:25.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-24T09:22:40.000Z (over 2 years ago)
- Last Synced: 2023-04-14T01:41:45.901Z (about 2 years ago)
- Topics: ceramic, dapp, ethereum, ipfs, nextjs, react, textileio, web3
- Language: JavaScript
- Homepage: https://connect-phi.vercel.app
- Size: 4.05 MB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Contributing
#### Developing
The development branch is `main`. This is the branch that all pull requests should be made against. The changes on the `main` branch are published to GitHub release regularly.
To develop locally:
1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository to your
own GitHub account and then
[clone](https://help.github.com/articles/cloning-a-repository/) it to your local device.
2. Create a new branch:
```sh
git checkout -b MY_BRANCH_NAME
```
3. Install the dependencies with:
```sh
npm ci
```
4. Start developing and watch for code changes:
```sh
npm run dev
```
5. It will open a browser tab at `http://localhost:3000/`
#### Building
You can build the project, with:
```sh
npm run build
```
You can then serve the built files from a server, with:
```sh
mpm run start
```
#### Testing
```sh
npm run test
```
If you would like to see the coverage, you can do
```sh
npm run test:coverage
```
#### Linting
To check the formatting of your code:
```sh
npm run lint
```
## Authors
- Robin Thomas ([@robin-thomas](https://github.com/robin-thomas)]
