Spot On API

Powering the Spot On Game Experience

This API serves as the backend engine for the Spot On puzzle application, a platform designed to challenge and engage users with various types of puzzles.

Getting Started

• API Endpoint: https://api.spot-on.webdevstuff.ninja
• API Documentation: https://api.spot-on.webdevstuff.ninja/docs/api
• Live App: Check out the live Spot On app at https://spot-on.webdevstuff.ninja

Project Planning

Get a glimpse into the project's planning and development process by exploring our Notion board and our Entity Relationship Diagram.

Technologies Used

• JavaScript
• Node.js
• Express.js
• Mongoose

Attributions

We extend our gratitude to the following external resources that played a crucial role in developing this API:

• Platforms: Heroku, MongoDB, Vercel, AuthKit (by WorkOS)
• NPM Packages: cookie-parser, cors, express, iron-session, jose, mongoose, swagger-ui-express, dotenv, https-localhost, nodemon, swagger-autogen

Next Steps

We're constantly striving to improve the Spot On experience. Here's a peek at some exciting features beingconsidered for the future:

• Supporting players connecting with their friends and compare stats in private leaderboards
• Supporting players creating their own custom puzzles to share with friends

Looking for the Frontend Code?

The frontend code for the Spot On application resides in a separate repository: link to your frontend Github repo here: https://github.com/iangilmore/spot-on/