Welcome to the developer documentation for the Guesstimator app! The documentation is divided into different sections depending on what kind of information you are looking for.
If you're new to the project, start with our Getting Started tutorial.
Tutorials
These are useful for learning how to work with our tech stack. This curated list of tutorials is meant to help you get up to speed if something is new to you.
How-To
These docs are useful if you need to know how to do a particular kind of task.
- How to create Svelte Components
- How to create an API endpoint
- How to write unit tests
- How to update dependencies
- How to edit these docs
Reference documentation
These docs are useful if you need to look something up while you're working.
- Architecture diagram
- API Reference Describes the backend API
- Database schema Describes the database schema
- Deploy pipeline describes our GitHub Actions
- Tech stack links to external documentation for the technology we use.
Context
These docs are useful if you want to understand why the project is the way it is.
- About the docs
- Colors
- Linting and Formatting
- REST architecture overview
- Why did we pick this tech stack?
- API Rate Limits
- Inactive room cleanup policy
Frontend
- Deploy configuration - Why we (currently) deploy as a static SPA