A site for storing sources for debates/arguments, along with quotes from those sources and notes about the sources.
This site comes from me wanting to have a place to easily store sources for arguments/debates that I have with people. Currently I use a google doc to do this, which works fine, but it would be better if there was a dedicated area to keep things like that. Where the sources can have quotes written under them, be sorted into addressing different arguments within the larger debate. Things like storing the best counters to different arguments, and my current best version of the argument would also be useful to have next to the sources for the particular argument. A place for more general notes about the different arguments is also something that would be nice to have, but out of the way.
DebateDB solves this by providing a store of all the things mentioned above. Split into an easily navigatable set of debates and arguments so that sources for specific arguments can be found quickly rather than having to sort through unordered notes.
There are 2 terms that are important to define for this site:
- Debate
- Argument
A debate is a collection of points that are all related to each other. They might all share the same topic, or all be part of one conversation with someone that happened in real life.
- Example: Has the implementation of the Congestion Charge been positive in London.
An argument is a smaller, individual point in a debate. An argument should be either fully sourced, or be clearly marked as opinion. The argument of the site contains areas for sources, quotes from the sources, notes about the argument, counters to the arguments, the current form of the argument and the best counters to the argument.
- Example: Congestion in London has fallen since the introduction of the Congestion Charge
There are 3 main pages in the site:
- Debates
- Arguments
- Argument
All page names describe what the pages are pretty simply. Debates is where all the debates are stored, arguments is where all the arguments are stored and argument is where the individual arguments with their sources are stored.
This project aims to follow the basic Vue style guide structure as well as possible.
All components are in the components folder. All components that are only used in one view have their names start with the name of that view.
Views all have "View" in their names so that classes/interface's can be easily made for their inputs (e.g. Argument is an interface, and a view). Component names do not have to include the "View" part of the views name.
This project does not use Vuex (even though it is installed) as it is not likely to be large enough to need it (and I don't know how to use it). It is installed so if the project size increases above what was origionally planned then it can be used.
Imports for every file should go in the order
- npm modules
- components
- models
- db classes
For the db files imports should be in the order
- classData
- elements
- data
Classes within db files should be in the orrder
- TableBase
- element
- data
This order is not based on anything, just personal preference
Source for convensions
- Components that are only used once in a view (but can be used in multiple views) should start with "The"
- Filenames of single-file components should always use PascalCase (e.g. AccountCard.vue)
- Components that are only used by one view should be in their own folder within the components folder (this isn't in the source, it's my own opinion)
- I chose not to use helper functions for the most part. Most components are fairly easy to understand and the code for each function (outside of some of the modal opening functions) isn't too long. Also I've already written the functions and reeeeeeealy cannot be bothered to move them now
docker build -t exilliar/debatedb-frontend:latest .
docker push exilliar/debatedb-frontend:latest
npm install
npm run serve
npm run build
npm run test
npm run lint
npm run test:unit