/verite-credential-utils

Primary LanguageTypeScriptMIT LicenseMIT

Credential Utils

This is a service for issuing and verifying Verite credentials for testing purposes, useful for hackathons, local integrations, etc.

Getting Started

Installation

Upon first checkout of this codebase, you should run the setup script:

npm run setup

This will install all dependencies and perform any other necessary setup.

Running the Server

First, run the development server:

npm run dev

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

Scripts

There are several scripts included to help improve your development experience:

  • npm run setup: Installs all dependencies and performs any necessary setup.
  • npm run dev: Runs the development server.
  • npm run lint: Runs the linter.
  • npm run format: Runs the formatter (prettier).
  • npm run type-check: Runs the type checker.
  • npm test: Runs the unit tests.
  • npm run build: Builds the application for production.

Environment variables

Environment variables are stored in .env locally, which is ignored by source control. The default variables are set up during the npm run setup script.

When running locally, you will likely want to change the HOSTNAME variable in .env to your local IP address, which will allow the mobile wallet to properly connect to the server.

Visual Studio Code

This project includes some default settings for Visual Studio code, including auto-format (using Prettier) upon save. It also includes a list of recommended extensions.

These settings are located in the .vscode directory.

Learn more

This project was created using create-next-app.

The following tools are used for this project:

  • Next.js for building and serving the React frontend and node API
  • TypeScript
  • TailwindCSS for rapid development using utility-first CSS classes
  • Prettier for code formatting
  • ESLint for code linting
  • Jest for unit testing
  • Github Actions enabled by default