Develop API route for Total XP about dolphin-flashcard-app HOT 3 CLOSED

The first stage is to test the current API methods to understand them. To do this, you can use an app called insomnia - https://insomnia.rest/download. Let me know if you need more info, but you do the following:

• Download this code and make sure python is installed
• Make sure backend/database/database_config.py stores type="local" to write to local files and not the actual database (for development and testing`
• Type in pip3 install -r requirements.txt to the terminal
• Type in python3 backend/main.py to the terminal
  This will tell you the URL the backend API server is running at

Note that if you don't use insomnia, you can go to a URL in your browser, but I don't think you can add json data to tell it userID and things like that.

Then, open insomnia:

• Choose an API route to test. I would test /api/create-account from https://github.com/jacob-macleod/Flashcard-App/blob/main/backend/routes/api/authentication.py
• Enter the URL from flask to Insomnia, adding /api/create-account. Select the POST method because in the code for that route it says methods=["POST"]
• Select the button to enter json in the text area of insomnia. Enter the following:

{
  "userID":"my-id",
  "displayName": "my-name"
}

You can change the string values if you want, When you're ready, press the button to go to the route. A 200 OK message should be returned, telling you there were no errors. Open data.json, and you'll see that your new data has been added. Try this with a few more API routes to get a feel for how it works.

You'll need to do this to create an account so that when you read a user's totalXP, there will actually be a user. When you write the code to get a user's XP, and test it in insomnia, you will be passing it a json file that looks similar to this:

{
  "userID":"my-id"
}

Provided you tell it to accept that in the code. my-id will need to be the ID of an existing user stored in data.json

If you have any questions, please ask!

from dolphin-flashcard-app.

(This issue is not ready to be worked on yet)

from dolphin-flashcard-app.

This is now done

from dolphin-flashcard-app.