Light

jet-set-radio-api / jetsetradio-api Goto Github PK

View Code? Open in Web Editor NEW

1.0 0.0 1.0 556 KB

A public JSON API providing Jet Set Radio data! Created by: RazzNBlue

Home Page: https://jetsetradio-api.onrender.com/

License: Apache License 2.0

JavaScript 81.42% HTML 14.62% CSS 3.96%

jetsetradio jsr nodejs rest-api api express jsrf mongodb onrender jetsetradiofuture

jetsetradio-api's Introduction

JetSetRadio-API

Easily consume Jet Set Radio data into your applications! This public API includes data from both JSR and JSRF.

Purpose

This application is meant to be a service anyone can use to call and get data relating to anything from the JetSetRadio universe.

Overview

This is an open-source software free for anyone to use. I do NOT claim to own. *NOTE: I do NOT own JetSetRadio, JetSetRadioFuture, or any entity falling under the JetSetRadio franchise. I do not own the name Jet-Set-Radio-API. I do not own any of the content provided by this API.

How To Run

See these instructions on how to set up a development environment. The only dependency this project has is a mongo database.

Endpoints and DOCS

View all endpoints on the Docs Page or the Swagger Docs

Integrations

MongoDB
SwaggerUI and swagger-autogen
Jest integration and unit tests for smoother development

Contributing

I am open and welcome to ALL contributions.

Please submit a Pull Request off of main with your proposed changes. You can also submit an issue if you find something wrong, have questions, or want to discuss something further.

Feel free to post anything under Issues even if it is a question or comment. If you see something incorrect from any of the endpoints, that is definitely something you can post about.

Author

RazzNBlue

License

Apache 2.0

Acknowledgements

SEGA - Creators and Owners of Jet Set Radio
Hideki Naganuma - Composer, DJ, and Remixer of Jet Set Radio Music
All other artists that contributed to the franchise
The Creators and Contributors of JetSetPedia
Greg Kennedy for gathering all of the JSR Graffiti Files into one organized place.
The JetSetRadio Community

jetsetradio-api's People

Contributors

Stargazers

Forkers

jetsetradio-api's Issues

Mystery Tape Integration

Simplify MONGO environment variables

Instead of separating the different parts of the mongo connection string, combine them into one to make it easier to get the project up and running.

We want to go from this

MONGO_USER=
MONGO_PASS=
MONGO_CLUSTER=
MONGO_DOMAIN=

To THIS:

MONGO_URI=

Add Sorting, Filtering, and Limit parameters to API Requests

Enable the use of sort, filter, and limit on all api requests.

JSR Achievements Integration

Add Caching to API Requests

Enable caching on API requests for super fast data retrieval!

Create UI for landing page

Create a landing page. It should be a simple and nice looking page perhaps with some photos, and a list of some endpoints. It should provide links to the /docs page and github repo.

Graffiti Soul Integration

Move Location for assets/images

Currently, the JSRF graffiti-tag images are hosted on google cloud storage. However, we have reached the free tier limit. To avoid fees, move the images to asset-service.

Street Challenges Integration

Add Song and Artist Public API endpoints

Data has been ingested for these two data points not we need to create the API endpoints to consume from the DB!

Here are some routes to include, but feel free to add more!
songs/jsr
songs/jsr/:id
songs/jsrf
songs/jsrf/:id
artists
artists/:id
artists/:id/songs

Jet Challenges Integration

Add Parameters to Swagger Docs

The API supports query parameters in the request url but they are not documented yet in the swagger docs. This would involve modifying the swagger config to include available query parameters for use. Currently, we use swagger-autogen to automatically generate swagger docs.

The swagger config file would be a good place to start researching, as well as the swagger-auto-gen documentation.

Grind Tricks Integration

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.