This app aims to facilitate squad growth in PUBG by tracking squad progress over time. In the future, we will add social aspects (find and meet other squads, etc etc).
Past:
- A screen showing collection of shard data, status and version of API, and a screenshot of a user's recent games and squad members.
- A first screen that collects data about the user's platform and region and shows status and version of pubg API
- A screenshot of a user searching for their name
- first screen
The repository has been set up as a yarn workspace (so, you'll need yarn) - this means running yarn
installs all dependencies for the whole project. All yarn tasks should be run from the root directory.
Since there's some sensitive data required to run the app (db connections, api tokens), I've set up environment variables, so you'll need to set up your own! I hate polution my global environment with variables so this project uses local environment variables. To get started, run yarn setup
which will install the project dependencies and set up a .env
file with default values in the squadgoals-api
directory. Adjust the values and see below to get started.
Run yarn dev
to spin up the dev servers. The API runs at http://localhost:5000
and the ui runs at http://localhost:3000
. The API inadvertently serves the last "built" version of the ui at http://localhost:5000/
. This does not have hot-reloading - but could be useful to reference to smoke test a build. The UI proxies requests to the API, so you can easily develop the api at http://localhost:3000
.