Typedoc Documentation Website

Todo

• Add license file and distribute to all repos using GitHub Action (Thomas)
• Finish writing integration tests for puzzle endpoint (Thomas)
• Write GitHub hook to run all tests before Push to repo (Thomas)
• Set up Dev and Prod Lambda environments (Thomas/Gregory)
• Add Mermaid documentation and distribute to all repos using GitHub Action (Thomas)
• Clean up docker implementation (auto-rebuild) (Thomas)
• Display integration test results with reporter (Thomas)
• Decide on initial JSON structure for remaining endpoints (Team)
• Write logic for remaining endpoints (Daniel)
• Write sanitation and validation for remaining endpoints (Daniel)
• Write Postman integration tests for remaining endpoints (Daniel)
• Set up Auth0 token authentication (Thomas/Daniel)
• Write up OpenAPI specifications for endpoints (Thomas/Daniel)
• Resolve remaining //todo items (Thomas/Daniel)
• Determine how to set Prod environment to use versioning control (Thomas/Gregory)
• Implement unit tests if needed (Thomas/Daniel)

Developer Setup

1. Install Docker on your machine. Tutorial is linked below:
   
   
2. Login to docker with the command docker login --username <GitHub_Username>
   You will be asked for your password, which is your GitHub Token. Make sure your GitHub Token has permissions to access GitHub's Container Registry!
   The needed scope is read:packages
   This command should be run in the terminal in the root folder of this project.
   
3. Follow this tutorial here for ensuring docker images are up to date: Docker image tutorial
   
4. The Mongo image can be run with this command in the root folder:
   Note use sudo on Linux/Mac
   

npm run docker

5. Create .env file with environment variables
6. Run npm i
7. The app can then be run with the command:
   

npm run start

8. Integration tests can be run when the app is running with this command:
   

npm run test:integration

Endpoint Documentation

GET newGame endpoint:

Creates a newGame for the user.
Example:
method: GET
url: http://localhost:2901/api/v1/newGame?difficulty=1
Header: Authorization: "Bearer " + accessToken

Returns:

[
    {
        "userID": "auth0|639440c8f2906775079c7254",
        "puzzle": "310084002200150006570003010423708095760030000009562030050006070007000900000001500",
        "currentTime": 0,
        "numHintsAskedFor": 0,
        "numWrongCellsPlayed": 0,
        "_id": "641109a19a155b57126fe647",
        "moves": [],
        "__v": 0
    }
]

puzzle can be accessed by the following:
response[0].puzzle