From f5092eb9c425fec95a6c1a81ad15f787708247ba Mon Sep 17 00:00:00 2001 From: Adefolaoluwayan Adeoye Date: Mon, 23 Feb 2026 15:43:47 +0000 Subject: [PATCH 01/11] Update project name from Lumache to Unify --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 03d09a55d..5b3a235fd 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1,4 @@ -Welcome to Lumache's documentation! +Welcome to Unify documentation! =================================== **Lumache** (/lu'make/) is a Python library for cooks and food lovers From f425fe4b64e1634aef0f1b59537cb9e35940be08 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 18 Mar 2026 18:00:31 +0000 Subject: [PATCH 02/11] Revise usage instructions for starting database and app Updated usage documentation to reflect starting the database and running the app. --- docs/source/usage.rst | 29 +++++++---------------------- 1 file changed, 7 insertions(+), 22 deletions(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 924afcf6c..872523558 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -1,34 +1,19 @@ Usage ===== -.. _installation: +.. _startdatabase: -Installation +Start Database ------------ -To use Lumache, first install it using pip: +To start the database (as it is local during development), cd to backend and run the command ''python manage.py runserver'' .. code-block:: console - (.venv) $ pip install lumache + cd backend + python manage.py runserver -Creating recipes +Start App ---------------- -To retrieve a list of random ingredients, -you can use the ``lumache.get_random_ingredients()`` function: - -.. autofunction:: lumache.get_random_ingredients - -The ``kind`` parameter should be either ``"meat"``, ``"fish"``, -or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients` -will raise an exception. - -.. autoexception:: lumache.InvalidKindError - -For example: - ->>> import lumache ->>> lumache.get_random_ingredients() -['shells', 'gorgonzola', 'parsley'] - +To run the app, navigate to ''main.dart'' and run without debugging. Choose any browser when it is prompted. From e88c50e8855bf374ee6c6da2987fa9273abe761a Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 18 Mar 2026 18:00:50 +0000 Subject: [PATCH 03/11] Add login and sign up section to documentation Added login and sign up instructions to the documentation. --- docs/source/api.rst | 7 ------- docs/source/login.rst | 14 ++++++++++++++ 2 files changed, 14 insertions(+), 7 deletions(-) delete mode 100644 docs/source/api.rst create mode 100644 docs/source/login.rst diff --git a/docs/source/api.rst b/docs/source/api.rst deleted file mode 100644 index ec94338a6..000000000 --- a/docs/source/api.rst +++ /dev/null @@ -1,7 +0,0 @@ -API -=== - -.. autosummary:: - :toctree: generated - - lumache diff --git a/docs/source/login.rst b/docs/source/login.rst new file mode 100644 index 000000000..d389310db --- /dev/null +++ b/docs/source/login.rst @@ -0,0 +1,14 @@ +Login +===== + +.. _login: + +Login/Sign up +--------------- + +To log in or sign up, either click the top right user icon, or the "Join a Society today" button + +Sign up +---------------- + +When signing up to use the website, you need to input your preferred name, email, and password. This will then be stored in our database, and will allow you to log in from the login screen From 61c51cd7bec8dbc9ad004dfd3d1878355c4c2fcd Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 18 Mar 2026 18:01:09 +0000 Subject: [PATCH 04/11] Revise documentation for Unify project Updated project name and description in documentation. --- docs/source/index.rst | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 5b3a235fd..f486b8bd8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,7 @@ -Welcome to Unify documentation! +Welcome to Unify's documentation! =================================== -**Lumache** (/lu'make/) is a Python library for cooks and food lovers -that creates recipes mixing random ingredients. -It pulls data from the `Open Food Facts database `_ -and offers a *simple* and *intuitive* API. +Unify is a student created, university focused website focused on societies, students and ease of access. Check out the :doc:`usage` section for further information, including how to :ref:`installation` the project. @@ -19,4 +16,6 @@ Contents .. toctree:: usage - api + login + +Unify hosts its documentation on Read the Docs. From e16a2b89fd9147f32cde1f0c7d9771919fe5b091 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:14:21 +0000 Subject: [PATCH 05/11] Add 'joinsoc' and 'review' to the documentation index --- docs/source/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/index.rst b/docs/source/index.rst index f486b8bd8..8c1f455f6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,5 +17,7 @@ Contents usage login + joinsoc + review Unify hosts its documentation on Read the Docs. From 14fa59c23328980190eb4dcf4b543e5757c802d3 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:14:32 +0000 Subject: [PATCH 06/11] Create joinsoc.rst --- docs/source/joinsoc.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/source/joinsoc.rst diff --git a/docs/source/joinsoc.rst b/docs/source/joinsoc.rst new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/docs/source/joinsoc.rst @@ -0,0 +1 @@ + From 5538dfc76747f6246dd2f0cd82858a9c62989472 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:14:50 +0000 Subject: [PATCH 07/11] Add joining and leaving instructions for society --- docs/source/joinsoc.rst | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/source/joinsoc.rst b/docs/source/joinsoc.rst index 8b1378917..15920f74a 100644 --- a/docs/source/joinsoc.rst +++ b/docs/source/joinsoc.rst @@ -1 +1,16 @@ +Join Society +============= + +.. _joinsoc: + +Joining a society +----------------- + +To join a society, you first have to be logged in. (refer to login page) After logging in, you can select a society using the "Find societies" button. +This will show you a list of societies, where you can search and filter for your specific interests. To join, click on the society you want to join, +and press the prompted button + +Leaving a society +------------------ +In order to leave, simply press the "Joined" button, and this will make you leave the society. From 8cf0e551fb2dcdc90ce61dfc59db3935c22336bd Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:15:09 +0000 Subject: [PATCH 08/11] Update login documentation to reflect joining process --- docs/source/login.rst | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/docs/source/login.rst b/docs/source/login.rst index d389310db..d3319334d 100644 --- a/docs/source/login.rst +++ b/docs/source/login.rst @@ -1,14 +1,15 @@ -Login -===== +Join Society +============= -.. _login: +.. _joinsoc: -Login/Sign up ---------------- +Joining a society +----------------- -To log in or sign up, either click the top right user icon, or the "Join a Society today" button +To join a society, you first have to be logged in. (refer to login page) After logging in, you can select a society using the "Find societies" button. +This will show you a list of societies, where you can search and filter for your specific interests. To join, click on the society you want to join, +and press the prompted button -Sign up ----------------- - -When signing up to use the website, you need to input your preferred name, email, and password. This will then be stored in our database, and will allow you to log in from the login screen +Leaving a society +------------------ +In order to leave, simply press the "Joined" button, and this will make you leave the society. From de5ffec276138664c07a024ff195eee739eff492 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:15:23 +0000 Subject: [PATCH 09/11] Modify usage.rst for backend and frontend instructions Updated usage instructions for starting the backend server and running the frontend app. --- docs/source/usage.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 872523558..d13ea10c4 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -11,9 +11,16 @@ To start the database (as it is local during development), cd to backend and run .. code-block:: console cd backend - python manage.py runserver + ..\.venv\Scripts\activate + python manage.py runserver 0.0.0.0:8000 Start App ---------------- To run the app, navigate to ''main.dart'' and run without debugging. Choose any browser when it is prompted. +Alternatively, run this in a new terminal (after the server is running) + +.. code-block:: console + + cd "unify_frontend" + flutter run -d chrome From 64d70833f965991889a0eb31d6ef415b4190c9b6 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:15:49 +0000 Subject: [PATCH 10/11] Create review instructions in review.rst Added instructions for leaving a review in the review.rst file. --- docs/source/review.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docs/source/review.rst diff --git a/docs/source/review.rst b/docs/source/review.rst new file mode 100644 index 000000000..f355ebf46 --- /dev/null +++ b/docs/source/review.rst @@ -0,0 +1,10 @@ +Review +===== + +.. _review: + +Create Review +--------------- + +You can only leave a review in a society you have joined. to leave a review, input the rating (out of 5) and enter a comment. Your review +will be visible to everyone From 6ffa35e75206d224ea80d5f51e73b5e4edefc0e8 Mon Sep 17 00:00:00 2001 From: alcajuice <235305961+alcajuice@users.noreply.github.com> Date: Wed, 25 Mar 2026 14:18:20 +0000 Subject: [PATCH 11/11] Update login documentation and add sign up section --- docs/source/login.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/source/login.rst b/docs/source/login.rst index d3319334d..3b6cf1fef 100644 --- a/docs/source/login.rst +++ b/docs/source/login.rst @@ -1,15 +1,16 @@ -Join Society -============= +Login +===== -.. _joinsoc: +.. _login: -Joining a society ------------------ +Login/Sign up +--------------- -To join a society, you first have to be logged in. (refer to login page) After logging in, you can select a society using the "Find societies" button. -This will show you a list of societies, where you can search and filter for your specific interests. To join, click on the society you want to join, -and press the prompted button +To log in or sign up, either click the top right user icon, or the "Join a Society today" button +You will be prompted to input your email and password. If you have not created an account, use the "Create Account" button. -Leaving a society ------------------- -In order to leave, simply press the "Joined" button, and this will make you leave the society. +.. _signup: +Sign up +---------------- + +When signing up to use the website, you need to input your preferred name, email, and password. This will then be stored in our database, and will allow you to log in from the login screen.