To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your tohacks-sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('tohacks-sdk') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TohacksSdk = require('tohacks-sdk');


var api = new TohacksSdk.DefaultApi()
var opts = {
  'apiAdminAuthPostBody': new TohacksSdk.ApiAdminAuthPostBody() // {ApiAdminAuthPostBody} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.apiAdminAuthPost(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Class	Method	HTTP request	Description
TohacksSdk.DefaultApi	apiAdminAuthPost	POST /api/admin/auth	Admin Authentication
TohacksSdk.DefaultApi	apiAdminCategoryDelete	DELETE /api/admin/category	Delete Category
TohacksSdk.DefaultApi	apiAdminCategoryGet	GET /api/admin/category	Query Categories
TohacksSdk.DefaultApi	apiAdminCategoryPut	PUT /api/admin/category	Create/Update Category
TohacksSdk.DefaultApi	apiAdminJudgesAssignPost	POST /api/admin/judges/assign	Assign Judges
TohacksSdk.DefaultApi	apiAdminJudgesDelete	DELETE /api/admin/judges	Delete Judge
TohacksSdk.DefaultApi	apiAdminJudgesDiligencePost	POST /api/admin/judges/diligence	Due Diligence
TohacksSdk.DefaultApi	apiAdminJudgesGet	GET /api/admin/judges	Query Judges
TohacksSdk.DefaultApi	apiAdminJudgesPost	POST /api/admin/judges	Upload Judges
TohacksSdk.DefaultApi	apiAdminJudgesPut	PUT /api/admin/judges	Create/Update Judge
TohacksSdk.DefaultApi	apiAdminMailPost	POST /api/admin/mail	Send Mail
TohacksSdk.DefaultApi	apiAdminPingGet	GET /api/admin/ping	Ping
TohacksSdk.DefaultApi	apiAdminProjectsDelete	DELETE /api/admin/projects	Delete Project
TohacksSdk.DefaultApi	apiAdminProjectsDiligencePost	POST /api/admin/projects/diligence	Due Diligence
TohacksSdk.DefaultApi	apiAdminProjectsGet	GET /api/admin/projects	Query Projects
TohacksSdk.DefaultApi	apiAdminProjectsPost	POST /api/admin/projects	Upload Projects
TohacksSdk.DefaultApi	apiAdminProjectsPut	PUT /api/admin/projects	Create/Update Project
TohacksSdk.DefaultApi	apiAdminScoringGet	GET /api/admin/scoring	Query Scorings
TohacksSdk.DefaultApi	apiJudgeAuthPost	POST /api/judge/auth	Judge Authentication
TohacksSdk.DefaultApi	apiJudgeMeGet	GET /api/judge/me	Get Profile
TohacksSdk.DefaultApi	apiJudgePingGet	GET /api/judge/ping	Ping
TohacksSdk.DefaultApi	apiJudgeProjectsGet	GET /api/judge/projects
TohacksSdk.DefaultApi	apiJudgeProjectsTojudgeGet	GET /api/judge/projects/tojudge
TohacksSdk.DefaultApi	apiJudgeScoringCriteriaGet	GET /api/judge/scoring-criteria
TohacksSdk.DefaultApi	apiJudgeScoringGet	GET /api/judge/scoring
TohacksSdk.DefaultApi	apiJudgeScoringPut	PUT /api/judge/scoring
TohacksSdk.DefaultApi	apiJudgeSubmitPost	POST /api/judge/submit	Finish Judging

Documentation for Models

Documentation for Authorization

cookieAuth

Type: API key
API key parameter name: session
Location:

FAQs

What is @t0hacks/tohacks-sdk?

Is @t0hacks/tohacks-sdk popular?

Is @t0hacks/tohacks-sdk well maintained?

Package last updated on 27 May 2022

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install