Skip to content

VarunAgw/LOTR-SDK

Repository files navigation

Take home project - The Lord of the Rings SDK

Sample project:

For a sample project using this SDK, see example/ directory and example/README.md.

Important Documents

  1. TASK.md explains the project
  2. DESIGN.md explains the code architecture

Requirements:

  1. Git
  2. Node.js

Installation:

  1. Run npm install.
  2. Run npx husky install to setup git hooks.

How to start the SDK

  1. Run npm start.

How to use/test SDK

  1. Use the sample project in example/ directory.

How to build the project

  1. Run npm run build

How to publish to npm registry

  1. Run npm publish

Important Links

  1. Github Repository
  2. NPM Package

About

Take home project - The Lord of the Rings SDK

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published