Git Product home page Git Product logo

api's Introduction

TO BUILD

Dependencies

  1. NodeJS/NPM (Latest Stable Version)
  2. Gulp (sudo npm install -g gulp)

Setup

  1. cd to this directory
  2. npm install
  3. gulp
  4. npm start

GENERAL

This is a MEAN stack app without the A(ngular). It is the API for modwatch. It is fairly simple, just taking in JSON from the uploader, storing it at mongolab, and serving it out via API routes.

The general shape of the API is taking in data through /loadorder, which is only hit by the uploader. This route takes username, password, some descriptive fields, and file contents from Skyrim mod files as arrays. This is stored in MongoDB. The data is retrieved by the frontend site, which will pull anything from user profile data (types of files, username, last upload timestamp) to actual file data. All API routes are open, all data is available.

CONTRIBUTING

  1. Fork this repo
  2. Open an issue for the problem/enhancement you want to work on
  3. Create a branch that has to do with the issue you want to fix
  4. Implement your changes
  5. Make a pull request to this repo
  6. If there are no merge conflicts, and I've already approved the issue you created, I'll most likely merge your changes in

When making changes, do your best to follow the standards already set in other parts of the repo. Changes should not be noticeable when looking through source code. I would prefer all changes pass eslint with the .eslintrc in the root directory.

LINKS

api's People

Contributors

ansballard avatar

Watchers

 avatar  avatar

api's Issues

Documentation on using the API

We were talking in #skyrimmods on IRC about how to quickly and easily get up to speed with fetching a modwat.ch load order, so I started poking around thinking of ways to combine modwat.ch data with LOOT masterlist data. Based on https://github.com/Modwatch/API/blob/master/lib/server/routes/user.js it looks like there are some API endpoints for getting stuff like load orders, but I can't seem to access them. E.g., https://modwat.ch/api/user/Peanut/files just redirects me to the front page.

Is there any documentation (other than the source code) for how to access/use the API?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.