Skip to main content

Handover Documentation

Context​

I have revised the readme guide to ensure ease of project initiation for other team members and future successors. In addition, me and my team have written a reading guide and for the group project check this for the details.

Outcome: The markdown documentation​

BaaS (Backend-as-a-Service) - Supabase​

This guide will assume you are adjusting your data modeling and API on the default deployment on the official platform. In case you want to set up a local development server or self-hosting, check their documentation.

Account & Configuration​

  • Google account

    • Email: <...>
    • Password: <...>

  • Supabase account

    • Email: <...>
    • Password: <...>

Database connection​

By default, once you have created a project, the superbase will automatically set up a PostgreSQL database for your project. You can connect the database with any tool you like. In the current context, you don't need it, in case you prefer to do it your way.

Host: <...>
Database name: postgres
Port: 5432
User: postgres
Password: <...>

Link

API connection​

A RESTful endpoint for querying and managing your database.

URL: <...>
Annon public key: <...>

Supabase alredy provide the auto generate API documendation and comperhensive examples your can alaway search it in their documentation via Documentation

Below show some SDK examples:

  • Get single Object
  const { data, error } = await supabase
      .from('challenges')
      .select()
      .eq('id', id)
      .single()
  • Get list of Object
  cons { data, error } = await supabase
      .from('challenges')
      .select('*')
  • Insert and return Object
  const { data, error } = await supabase
      .from('smoothies')
      .insert([{ title, method, rating }])
      .select();

Authentication​

The Google auth has settup Click this Link to add any third party providers

image-20230315115751802

You can login the google account provided above to see google OAuth APP credential profile. Link

image-20230315115634047

Data modeling​

You can either directly use SQL or their interface to munipulate your data via: