Introduction

About the Project

The Wonderville Activity Board was built by a team from Code the Change YYC in collaboration with Wonderville. Wonderville is is an education technology non-profit focusing on STEM learning products for children in K-12. The Activity Board was created as a tool for location-based monitoring of both historical and realtime users of Wonderville's online products.

Project Structure

├── assets              // Assets for the documentation
├── docs                // The documentation build files
├── mdbook              // The documentation working files
├── frontend_react      // The React frontend
├── rest_golang         // The Go backend
├── mock_services       // Helper services for development
│   ├── mock_data       // Mock data seeding for MongoDB
│   └── mock_server     // Mock WebSocket server
└── docker-compose.yml  // The Docker Compose file

Application Architecture

The project is composed of a React frontend, Go REST backend and a MongoDB database; all of which are containerized with Docker. The frontend and backend listen to Wonderville's WebSocket server for displaying and recording new user sessions. More information on each service can be found in the upcoming sections.

Quick Start

To quick start the application:

1. Install Docker
2. Put the development .env file in the root of the project
3. Run docker compose --env-file .env up -d
4. The frontend of the application should be available on http://localhost:8081/

More development and troubleshooting related information can be found in the Development section of the documentation.

Documentation

Click here to view documentation.