Pokematic

Pokematic is a web application that fosters team collaboration and is designed to be a tool that rewards teams through “gamifying” team achievements. As teams complete tasks and gain achievements and milestones, the tool rewards teams with randomly generated Pokemon or Pokemon-based items. These rewards are added into a collective Pokédex within each team, where members of the team can view their achievements and track the progress of their incoming goals.

Technical Layout

The project consists of two main code bases: a backend (in pokematic-backend) and a frontend (in pokematic-frontend). The backend is a web api created with ASP.NET Core (coding language is C#). The frontend is a ReactJS project that interacts with the the backend API as well as the pokeapi.

Get Started!

To get the project running, follow these steps:

Prerequisites

• Visual Studio (for editing C# code) [or the equivalent dotnet command line tools, or JetBrains Rider]
• Install .Net Core 3.1 Runtime and SDK here (note you only need the SDK if you wish to further develop the pokematic backend)
• Visual Studio Code [or equivalent frontend tooling]
• NPM/NodeJS (for running the frontend)

Steps

1. Clone and/or download the repo to your local machine
2. Open the command line and navigate to where the pokematic code base is saved
3. Use the 'cd' command to navigate into the backend folder (pokematic-backend) and execute the command 'dotnet run'
4. Once the backend server is running, a new window will open displaying Swagger, which is a tool used for documentation and testing of the API endpoints
5. Open a new tab/new instance of the command line and navigate using the 'cd' command into the frontend folder (pokematic-frontend)
6. Execute the command 'npm install' to install required dependencies
7. Execute the command 'npm start' to start the React developmnet server
8. Your browser should open (or you may have to open a link from the React command line tool). You should see the pokematic home page prompting you to login.
9. Feel free to create a new account. However, it is recommended that if you are testing pokematic, you should use a dummy account as this will help you see all the features of pokematic more easily. To log into the dummy account enter the following credentials, Login: mockaccount@test.com passowrd: TestAccount1!