An API written in Flask for the Tamagochi application, an initiative of the research and development group at Universidade Positivo in the year of 2022/2023.
The Tamagochi application is an educational tool designed to assist children with their daily tasks through a virtual pet, similar to a Tamagochi. This repository contains only the API, without the graphical interface.
The following technologies and libraries were used in the development of this project:
To set up the project on your local machine, follow these steps:
- Make sure you have docker and docker compose installed properly.
- Clone this repository.
- Inside the directory, run:
docker compose up --build
Access your localhost.
- (Optional) add the domains and subdomains to
/etc/hosts
SERVER_ADDRESS=$(docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' tamagochi-nginx-1)
echo "$SERVER_ADDRESS tamagochi.up.br" >> /etc/hosts
echo "$SERVER_ADDRESS parent.tamagochi.up.br" >> /etc/hosts
echo "$SERVER_ADDRESS child.tamagochi.up.br" >> /etc/hosts
To see our current goals and more information about the project, visit our Notion page.
The API documentation can be accessed at /docs. From there, developers can understand the available endpoints and their functionalities.
As the project is still in its early stages of development, there may be known issues or limitations.
The following are the planned future enhancements for the project:
- Implement creation, editing, and deletion of tasks.
- Create a separate JWT for the "Child" user.
- Allow editing and deletion of the "Parent" and "Child" user.
All the code in this and other repositories solely belongs to Universidade Positivo. All rights reserved.