myLeaderboard

iLeaderboard, meet myLeaderboard

Getting Started

API

1. cd api
2. yarn
3. yarn start
4. The console will start an ngrok instance and provide a URL which tunnels to your local instance. You should be able to hit the various endpoints from here.
5. You'll probably want to update api/.env with a GitHub API Token so you aren't rate limited while testing.
6. Check out the API Reference
7. GraphQL endpoints are also available. With the server running, you can use GraphiQL

Dashboard

1. Follow steps to set up a local instance of the API. This will update dashboard/src/api/LeaderboardAPI.ts with the URL for your ngrok instance automatically.
2. cd dashboard
3. yarn
4. yarn start
5. The dashboard will be available at localhost:3000

iOS

1. Follow the steps to set up a local instance of the API. This will update ios/MyLeaderboard/MyLeaderboard/Source/API/MyLeaderboardAPI.swift with the URL for your ngrok instance automatically.
2. cd ios
3. If you are modifying queries, use ./generate_api to run Syrup and regenerate the models.

Requirements

API

• node (tested with 10.15+)
• yarn (tested with 1.22+)
• ngrok

Dashboard

• yarn (tested with 1.22+)

iOS

• Swift 5.0+
• swiftLint

Contributing

Clone the repo and follow the steps below for the component you're interested in contributing to:

API

1. Make your changes and run yarn lint to ensure there are no lint errors
2. Open a PR with your changes (don't include ngrok URLs) 🎉

Dashboard

1. Make your changes and run yarn lint to ensure there are no lint errors
2. Open a PR with your changes 🎉

iOS

1. Make your changes and run swiftlint to ensure there are no lint warnings or errors
2. Open a PR with your changes 🎉