Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ipfs-examples/js-ipfs-browser-angular

Example of using Angular with JS-IPFS
https://github.com/ipfs-examples/js-ipfs-browser-angular

Last synced: about 2 months ago
JSON representation

Example of using Angular with JS-IPFS

Host: GitHub
URL: https://github.com/ipfs-examples/js-ipfs-browser-angular
Owner: ipfs-examples
Created: 2021-08-24T09:13:28.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2022-09-26T13:42:14.000Z (about 2 years ago)
Last Synced: 2024-03-29T11:59:16.797Z (9 months ago)
Language: HTML
Homepage:
Size: 38.1 KB
Stars: 3
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        


  

    

  



IPFS Angular App




  Using js-ipfs with `Angular`

  


  


  

  


  Explore the docs

  ·

  View Demo

  ·

  Report Bug

  ·

  Request Feature



## Table of Contents

- [Table of Contents](#table-of-contents)

- [About The Project](#about-the-project)

- [Getting Started](#getting-started)

  - [Pre requisites](#pre-requisites)

  - [Installation and Running example](#installation-and-running-example)

  - [Available Scripts from create-react-app](#available-scripts-from-create-react-app)

    - [Development server](#development-server)

    - [Code scaffolding](#code-scaffolding)

    - [Build](#build)

    - [Running unit tests](#running-unit-tests)

    - [Running end-to-end tests](#running-end-to-end-tests)

    - [Further help](#further-help)

- [Usage](#usage)

- [References](#references)

- [Documentation](#documentation)

- [Contributing](#contributing)

- [Want to hack on IPFS?](#want-to-hack-on-ipfs)

## About The Project

- Read the [docs](https://github.com/ipfs/js-ipfs/tree/master/docs)

- Look into other [examples](https://github.com/ipfs-examples/js-ipfs-examples) to learn how to spawn an IPFS node in Node.js and in the Browser

- Consult the [Core API docs](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api) to see what you can do with an IPFS node

- Visit https://dweb-primer.ipfs.io to learn about IPFS and the concepts that underpin it

- Head over to https://proto.school to take interactive tutorials that cover core IPFS APIs

- Check out https://docs.ipfs.io for tips, how-tos and more

- See https://blog.ipfs.io for news and more

- Need help? Please ask 'How do I?' questions on https://discuss.ipfs.io

## Getting Started

### Pre requisites

Make sure you have installed all of the following prerequisites on your development machine:

- Git - [Download & Install Git](https://git-scm.com/downloads). OSX and Linux machines typically have this already installed.

- Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) and the npm package manager.

### Installation and Running example

```console

> npm install

> npm start

```

Now open your browser at `http://localhost:4200`

### Available Scripts from create-react-app

In the project directory, you can run:

#### Development server

Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.

#### Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

#### Build

Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.

#### Running unit tests

Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).

#### Running end-to-end tests

Run `ng e2e` to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.

#### Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.

## Usage

A minimal demonstration of how to use js-ipfs in a `angular` generated with [Angular CLI](https://github.com/angular/angular-cli) version 12.1.2.

Check the `ipfs.service.ts` file to how to use the basic of ipfs.

_For more examples, please refer to the [Documentation](#documentation)_

## References

- Documentation:

  - [IPFS CONFIG](https://github.com/ipfs/js-ipfs/blob/master/docs/CONFIG.md)

  - [MISCELLANEOUS](https://github.com/ipfs/js-ipfs/blob/master/docs/core-api/MISCELLANEOUS.md)

## Documentation

- [Config](https://docs.ipfs.io/)

- [Core API](https://github.com/ipfs/js-ipfs/tree/master/docs/core-api)

- [Examples](https://github.com/ipfs-examples/js-ipfs-examples)

- [Development](https://github.com/ipfs/js-ipfs/blob/master/docs/DEVELOPMENT.md)

- [Tutorials](https://proto.school)

## 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 IPFS Project

2. Create your Feature Branch (`git checkout -b feature/amazing-feature`)

3. Commit your Changes (`git commit -a -m 'feat: add some amazing feature'`)

4. Push to the Branch (`git push origin feature/amazing-feature`)

5. Open a Pull Request

## Want to hack on IPFS?

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

The IPFS implementation in JavaScript needs your help! There are a few things you can do right now to help out:

Read the [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md) and [JavaScript Contributing Guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md).

- **Check out existing issues** The [issue list](https://github.com/ipfs/js-ipfs/issues) has many that are marked as ['help wanted'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22) or ['difficulty:easy'](https://github.com/ipfs/js-ipfs/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Adifficulty%3Aeasy) which make great starting points for development, many of which can be tackled with no prior IPFS knowledge

- **Look at the [IPFS Roadmap](https://github.com/ipfs/roadmap)** This are the high priority items being worked on right now

- **Perform code reviews** More eyes will help

  a. speed the project along

  b. ensure quality, and

  c. reduce possible future bugs.

- **Add tests**. There can never be enough tests.

- **Join the [Weekly Core Implementations Call](https://github.com/ipfs/team-mgmt/issues/992)** it's where everyone discusses what's going on with IPFS and what's next