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/index.rst b/docs/source/index.rst index 03d09a55d..8c1f455f6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,7 @@ -Welcome to Lumache's 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,8 @@ Contents .. toctree:: usage - api + login + joinsoc + review + +Unify hosts its documentation on Read the Docs. diff --git a/docs/source/joinsoc.rst b/docs/source/joinsoc.rst new file mode 100644 index 000000000..15920f74a --- /dev/null +++ b/docs/source/joinsoc.rst @@ -0,0 +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. + diff --git a/docs/source/login.rst b/docs/source/login.rst new file mode 100644 index 000000000..3b6cf1fef --- /dev/null +++ b/docs/source/login.rst @@ -0,0 +1,16 @@ +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 +You will be prompted to input your email and password. If you have not created an account, use the "Create Account" button. + +.. _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. 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 diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 924afcf6c..d13ea10c4 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -1,34 +1,26 @@ 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 + ..\.venv\Scripts\activate + python manage.py runserver 0.0.0.0:8000 -Creating recipes +Start App ---------------- -To retrieve a list of random ingredients, -you can use the ``lumache.get_random_ingredients()`` function: +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) -.. 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'] +.. code-block:: console + cd "unify_frontend" + flutter run -d chrome