Introduction
Setup Instructions are on the main page of Docusaurus. Run instructions are also on the main page of the Docusaurus.
Below are links to project boards, resources, official documentation, and tutorials.
Project Boards and Resources
- Jira board
- Miro board - team document drafts and ideas
- Secret keys for .env variables in Discord and Miro
- Capstone site - syllabus, schedule, etc
- Canvas Course site
- Study Buddy's docusaurus - referenced as the gold standard for a documentation site
Quick start guides
- React and Tailwind
- Laravel
- Docker
- MongoDB
- Docusuarus
Documentation for Packages Used
- IGDB Laravel - IGDB API wrapper for Laravel to make API calls easier
- IGDB Games API - IGDB API Documentation
- Laravel Request Docs - Automatically generates an interactive API documentation website
- Laravel Magellan - Adds Postgres functionality for geospatial data
- Laravel Echo WebSocket - Laravel's frontend WebSocket library and wrapper for Pusher
- Pusher WebSocket - Pusher's frontend WebSocket documentation - Laravel Echo uses Pusher behind the scenes, so if you want to do more advanced stuff with the WebSocket client in the frontend, check out this documentation
- Zustand - Lightweight state management library for React
More Resources
ReactJS
Tailwind CSS
Docker
- Official Docker documentation
- Official Docker installation guide
- YouTube - Full Docker Tutorial Zero to Hero in 3 Hours
Laravel 10
Keep in mind that the some of the Laravel official documentation are written for people using it as BOTH the frontend and the backend. LOMO will ONLY be using Laravel as the API backend. Ignore docs referring to the views, "web.php" (the Laravel frontend routes), and other references to the Laravel frontend.
- Official Laravel documentation
- Laravel Routing doc
- Laravel Controller doc
- Laravel Model doc
- Laravel WebSocket doc
- Laravel Sanctum docs to authenticate API routes
- Laravel Testing docs
- Laravel Sail docs
- Blog Guide - Rate Limiting
MongoDB
Docusaurus
- Offical Docusaurus documentation
- Styling and Layout
- docusaurus2-dotenv-2
- redocusaurus - embed OpenAPI specs into docusaurus