Malaguth / skill-tracking

This repository aims to create an example of skill-tracking software made as a study exercise.
MIT License
5 stars 0 forks source link

Create Frontend Structure #42

Open ViniciusLAAraujo opened 7 months ago

ViniciusLAAraujo commented 7 months ago

In response to our recent discussions and decisions from our last meeting, I've made some changes to the draft to better align with the current thoughts (to use vite, etc). I've also taken the initiative to document our early concepts in a markdown file named "folder_structure.md". This file should explains the draft concepts for each folder and "main file".

ViniciusLAAraujo commented 7 months ago

Some topics we were studding about to make further changes (we are open to any inputs or directions):

  1. Modules structure still very raw, we will work on the idea of the "mapper" and see how it should actually work (if a interface is needed, ...)
  2. Views on separating static and non-static files.
  3. Have we decided on using styled-components ? should we stick to it or think about Tailwind, plain CSS, or something else ?
  4. Plans on handling sensitive data. Are we leaning towards environment variables, a key vault approach, ...
joaocolem commented 7 months ago

I believe styled-components is useful for keeping things organized and allows for practicing some vanilla CSS as well. Additionally, it has an easy entry to learn.

joaocolem commented 7 months ago

The idea behind services and mappers: I suggest having a general configuration file for the API and separating each API call into a specific folder with its corresponding service and mapper. For instance: user, userService, userMapper. Within userService, we would have functions like createUser (putUser), where the request is made, the mapper is utilized, and the result is returned in the required format.

Specific interfaces used in the request for the user route would be located in the "types" section.

Btw, I'm not sure if we really need an interface in this scenario.

ViniciusLAAraujo commented 6 months ago

Still missing (I'll try doing it before wednesday) :

Possibly missing (Don't actually know if those need to be done in this part) :

ViniciusLAAraujo commented 6 months ago

Done some of the following tech debt posted in the linked issue (I'll try to finish dev guide and change tests to use Vitest until tuesday)