miiverse-api/README.md
Jonathan Barrow 5669fe8e29
feat: add link to new repository in README
The `juxtaposition-ui` and `miiverse-api` services have been combined into a single monorepo, which now lives at https://github.com/PretendoNetwork/juxtaposition
2025-04-05 15:00:25 -04:00

19 lines
906 B
Markdown

> [!IMPORTANT]
> ## DEPRECATED. NOW LIVES IN https://github.com/PretendoNetwork/juxtaposition
# 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](https://nodejs.org) and [MongoDB](https://mongodb.com). 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
- [x] Discovery Server
- [x] Posts Server
- [ ] Topic Server
- [x] Communities Server
- [ ] Integrate with PN account server
# Currently implemented endpoints
- [GET] https://discovery.olv.nintendo.net/v1/endpoint
- [GET] https://api.olv.nintendo.net/v1/communities/0/posts
- [GET] https://discovery.olv.nintendo.net/v1/people
- [POST] https://api.olv.nintendo.net/v1/posts