Skip to content

TienCamLy/MiniTwit

Repository files navigation

Setting Up the Repository

TODO: Add installation instructions

Processes & Workflows

Contributions to this repository should be structured as necessary following these guidelines:

  • Project Work Activities are tracked through Trello
    • Trello tasks are linked to relevant GitHub Issues / Branches / PRs using the GitHub PowerUp
    • Tasks should be small enough that they may be solved within a short timeframe and individual from other tasks.
  • All Work should be done on branches representing a single task. In the case of multiple closely related tasks, these may be implemented on the same branch as necessary.
  • Branches shall not be merged directly to main, but peer reviewed using PRs before merging.

Naming Conventions

  • Practical changes not related to a particular feature: branches - 'chore/XXX' PRs - 'Chore: XXX'
  • Changes related to fixing bugs: branches - 'bug/XXX' PRs - 'Bug: XXX'
  • Changes related to writing/running tests: branches - 'test/XXX' PRs - 'Test: XXX'
  • Changes related to deployment/CICD flows: branches - 'deploy/XXX' PRs - 'Deploy: XXX'
  • Changes related to Refactoring: branches - 'refactor/XXX' PRs - 'Refactor: XXX'
  • Changes related to API implementation: branches - 'api/XXX' PRs - 'API: XXX'

Documentation of choices and issues

Choice of Programming Language / Tech Stack

We chose to refactor to C# with Razor Pages. This choice was made on the basis of picking a programming language that half of the group already knew and the other half found feasible to work with. Razor Pages was picked for the same reason, as we were intent on the familiarity for some of the group members gaining us the opportunity to move faster along with the refactoring.

We find Razor Pages to be a good choice, as it supports HTML templating similar to how Jinja is used within Flask applications. One of the main challenges was keeping track of the logged in user within a session, as each bit of code for each page was siloed in its own .cs file. We managed to keep common things common, such as Layout and database functionality, such that the page-specific code mere constituted the functionality of each page-function from the Flask application.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 5