Skip to content

Szboy/SunshineWebAPI

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

111 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sunshine travis

Sunshine is a REST API for interaction with the Overcast Network and all related services including the forums, servers, maps, and authenticated endpoints.

Sunshine provides these services, both authenticated, and non-authenticated through a JSON Web API served by NodeJS, with data scraped from the Overcast Network with Cheerio.

View the documentation for Sunshine on the website

Sunshine is not affiliated with the Overcast Network, and will not be held liable for the actions performed through the API.

Installing

  1. Install redis and NodeJS
  2. Run npm install.
  3. Start redis and run npm start

License

Sunshine is licensed to the Sunshine API Development team under the General Public License (GPL) v3 license, requiring that changes must be open sourced if the API is redistributed.

We suggest that you pull request any changes that you make in order to better the API for everyone, but this is not necessary in accordance to the license.

About

The final API for Overcast Network that returns JSON

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • JavaScript 91.6%
  • Handlebars 5.9%
  • CSS 2.5%