mirror of https://github.com/PretendoNetwork/miiverse-api.git synced 2026-03-21 17:24:38 -05:00

Pretendo Network's Miiverse service

Go to file

William Oldham 5a1c453a84 Some checks failed Build and Publish Docker Image / build-publish (push) Has been cancelled Details chore: update eslint common package		2025-02-01 20:59:11 +00:00
.github/workflows	Update docker.yml	2024-07-28 22:48:07 +02:00
.idea	Fixed wrong PID being used for in game messages	2023-10-23 20:30:38 -05:00
.postman	Added initial support for api testing via postman	2023-04-24 23:52:29 -05:00
postman/collections	Updated community test case to also validate error response formatting	2023-04-26 00:25:23 -05:00
src	style: lint ALL the files	2025-02-01 20:36:29 +00:00
test	style: lint ALL the files	2025-02-01 20:36:29 +00:00
.dockerignore	chore: update Docker setup	2024-07-02 15:11:43 -04:00
.gitignore	Added the start of unit tests	2023-04-25 15:57:44 -04:00
Dockerfile	chore: update Docker setup	2024-07-02 15:11:43 -04:00
eslint.config.mjs	chore: bump common eslint config to 0.0.2	2025-02-01 20:36:30 +00:00
LICENSE	Create LICENSE	2022-08-16 10:19:45 -05:00
package-lock.json	chore: update eslint common package	2025-02-01 20:59:11 +00:00
package.json	chore: update eslint common package	2025-02-01 20:59:11 +00:00
README.md	modify code to support config.json in root of repo	2022-05-08 15:37:25 +02:00
tsconfig.json	removed unnecessary type defs. prefer inference	2023-10-02 14:55:52 -04:00

README.md

What is this?

This is the Pretendo Network Miiverse API Server, which replaces the former Nintendo Network Miiverse API Server *.olv.nintendo.net

Install and usage

First install NodeJS and MongoDB. Download/clone this repo and run npm i to install all dependencies. Create a config.json to your liking (example in config.example.json). Run the server via npm run start.

To-Do

Discovery Server
Posts Server
Topic Server
Communities Server
Integrate with PN account server

Currently implemented endpoints