Skip to content

Missing backend setup instructions #42

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michaelstingl opened this issue Mar 3, 2025 · 1 comment
Open

Missing backend setup instructions #42

michaelstingl opened this issue Mar 3, 2025 · 1 comment

Comments

@michaelstingl
Copy link

Issue: Missing Backend Setup Instructions

The current README.md lacks information about the backend requirements for running the app locally.

Description

The app makes several API calls to endpoints like:

  • /api/v2/location/byBounds
  • /api/v2/location/update/{profileId}

However, there are no instructions on:

  • How to set up the required backend
  • If there's a mock API available for development
  • Configuration for connecting to the backend

Proposed Solution

Add a section to the README.md with:

  • Backend setup instructions
  • Required environment variables
  • Alternative development approach if no backend is available (mocks)

This would help new developers get started with the project more easily.

Impact

Currently, running the app locally with pnpm dev will result in API errors since the backend endpoints are not available.

@addiinnocent
Copy link
Contributor

Hi michaelstingl, thanks for your feedback and your proposed solution. This app is currently using the same backend api as our platform. You can find it here https://github.com/toplocs/tribelike. You'd need to run the /server without the frontend part. As we are currently re-structuring the endpoints, the app-latest branch should be the correct one to use.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants