FilPass

Table of Contents

• Table of Contents
• Introduction
• Getting Started
  • Requirements
  • Installing dependencies
  • Database Setup
    • Starting the container
    • Running migrations
    • Seeding the database with essential data
    • Seeding test data
  • Application Start Up
  • Running the application
  • Documentation
• Developer and System Administrator
• License
• Acceptable Use Policy
• Security

Introduction

FilPass is an oracle platform that facilitates data retrieval from the Filecoin network in a secure and efficient way.

Demo Video

Demo Video

Getting Started

To start using FilPass locally, follow the steps below.

Requirements

Before we follow to the setting up of the application, make sure you have the following tools installed:

• Node.js
• Docker
• Docker Compose

You will also need to have the following services set up:

• Mailgun

Installing dependencies

npm install

Database Setup

Starting the container

docker-compose up -d

Running migrations

npm run migrate

Seeding the database with essential data

npm run seed

Seeding test data

If you want to include testing users, you can also execute the following command:

npm run seed:dev

The command create the following test users:

• General users

  • [email protected] to [email protected] / password

• Users with specific roles (the email domain for specific users is defined on the config.js file)

  • test-super / password

If you have set the IS_DEV environment variable as true, the security code will be 1234

Application Start Up

Before starting the application, make sure you have the following files set up:

• Environment: Create a file named .env in the root folder by copying the .env.example file and filling in the missing information based on env-vars, also found in the root folder.

• System: Change the app information on the system.ts file to match your company information. You can find more information about the system configuration file at system-config.

Running the application

npm run dev:server

Open http://localhost:3000 with your browser to see the result.

Documentation

For more information about getting started and business rules, check the documentation page.

Developer and System Administrator

If you are a developer or a system administrator and want some useful commands, check the Developer Helpers page for more information.

License

This project is open-source under the MIT and Apache 2.0 licenses.

Acceptable Use Policy

Before you proceed to use FilPass, please make sure you read and understand the entire Acceptable Use Policy. By accessing or using FilPass, you agree to all terms in this Policy without modification of any of its terms.

Security

Your cooperation in maintaining the security of FilPass is highly appreciated. If you have identified a potential security vulnerability within the FilPass project, we kindly request that you handle the situation by following responsible disclosure practices, refraining from publicly posting the issue.

Rest assured, all credible and legitimate reports will be thoroughly investigated. To report any security vulnerabilities, please reach out to us via email at [email protected]. Your vigilance contributes to the ongoing security of the project and is essential in ensuring the privacy and integrity of the FilPass application.