A well-prepared development environment reduces bugs, speeds up deployment, and improves collaboration.
1. Local Development Setup
Code Editor
Visual Studio Code with Lua, SQL, and Git extensions is our preferred setup.
Version Control
Use Git for tracking changes and collaborating with others.
2. Local Server Environment
- Install a local RedM server instance to test changes without affecting your live server.
- Keep configurations separate for dev/staging and production.
- Use a minimal player count for quicker load times.
Always test on staging before pushing changes to production.
3. Hot Reload & Debugging
- Use
refresh
andrestart
commands in the console for quick reloads. - Enable debug modes in
config.lua
during development. - Use console logs (
print
) and structured logging for better traceability.
4. Database Management
- Install MySQL locally with a dedicated dev database.
- Use migration tools or SQL dump/restore for schema changes.
- Keep a versioned
database.sql
file in your repository.
5. Collaboration
- Use GitHub or GitLab for shared repositories.
- Write clear commit messages.
- Keep feature branches small and focused.
6. Recommended Tools
- Postman or Insomnia for API testing
- TablePlus or HeidiSQL for database management
- Discord webhooks for in-game event logging