Vysakh: /* How to Setup / Contribute ? */

2025-07-14T19:13:30Z

How to Setup / Contribute ?

← Older revision		Revision as of 19:13, 14 July 2025
Line 33:		Line 33:

	to setup a shell in which all the requirements are setup. Once you are in the dev shell you can proceed to run the application following the instructions mentioned in the README.md.		to setup a shell in which all the requirements are setup. Once you are in the dev shell you can proceed to run the application following the instructions mentioned in the README.md.

			# Fork The repo.
			# Create a feature branch
			# Send a PR explaining it in detail what you have done.

Vysakh: /* How to Setup / Contribute ? */

2025-07-14T19:11:49Z

How to Setup / Contribute ?

← Older revision		Revision as of 19:11, 14 July 2025
Line 32:		Line 32:
	nix develop		nix develop

	to setup a shell in which all the requirements are setup.		to setup a shell in which all the requirements are setup. Once you are in the dev shell you can proceed to run the application following the instructions mentioned in the README.md.

Vysakh: init

2025-07-14T19:10:56Z

init

New page

Now that's a Hatrick for posts. I was trying to learn elixir and Have now vibe coded a monstrosity which you can also call as an MVP. It's an upgrade from Clockwise. To understand this you must first Understand Clockwise.

=== Clockwise ===
So [https://clockwisenitc.netlify.app/ clockwise] was made as part of the 2023 [[CodeInit|Code INIT]] Conducted by [[Computer Science and Engineering Association (CSEA)|CSEA]] It was developed overnight and won the Code INIT challenge, more updates have been made to accomodate the changes in slots and future proof the application.

== Why we need more ? ==

With clockwise we were able to generate a static iCal file that will contain the courses for a semester and it's timings per week. This works well to only an extend. The dynamic nature of the classes require a dynamic solution. Special holidays, Class cancellations etc can't be updated with this as the data source is only loaded once and can't be updated remotely.

== Solution ==
I've hacked together [https://github.com/tellmeY18/miss%20minutes Miss Minutes] which for the better or for the worse a Vibe coded piece of software. I do realize that the code has a lotta technical debt. Half of the code in there are unused / redundant and are leftover as it's coming from the pheonix framework setup.

== What Works Now ? ==

The repo currently has a Pheonix app that can run and will provide an events url / dynamic iCal link that you can import to your Google Calendar. Or with much more frequent updates using the [https://icsx5.bitfire.at/ iCalX<sup>5</sup>] in pair with [https://github.com/SimpleMobileTools/Simple-Calendar Simple Calendar]. The events can be updated right now in a csv file and will immediately reflect in the user calendar. This opens up new possibility to timetable management as a CR, BR, or a ''faculty'' (when pigs fly) will be able to update the Class details realtime.

From start of this itself I had decided that I won't be making one more useless custom client software that will end up being unmaintained so I tried my best to build on top of exisiting standards and well maintained applications.

== What Next ==
As I'm writing this I've a rough Idea on what has to be implemented next.

# Clean up the repo and remove all the unneeded code snippets trimming down the codebase to the absoloute minimum number of files / lines of code for the current functionalities.
# Move to sqlite for storing data and a single user login page with UI to manage the user specific data. (Each CR / BR ) Should be able to see / edit only their stream.
# Draft Documentation on How to subscirbe to the generated URl.
(hopefully will add the other items soon)

== How to Setup / Contribute ? ==

The code is currently available at my Github Repo [https://github.com/tellmeY18/miss_minutes tellmeY18/miss_minutes] the setup contains a flake.nix file which helps you setup a dev environment with all the required dependencies.
Simply run

nix develop

to setup a shell in which all the requirements are setup.

Miss Minutes - Revision history

Vysakh: /* How to Setup / Contribute ? */

Vysakh: /* How to Setup / Contribute ? */

Vysakh: init