Goal Site Get Started

[pallabez]

Scoping

There are three almost similar project namely -

• Learn Site

User can find road map of the skill they want to learn.

• Task Workflow

All issues/tasks that are public are listed here.
Eg - Write test, Setup CI/CD 

• Goal Site

Goals that are on a personal level.
Eg - Learn about HTML, Watch xyz youtube video

Views

There are 2 views possible currently for.

Super user - User that have ability to manage goals
User - Normal users

• List of goals assigned to you
• User profile and name
• List of goals publicly visible
• Goal status and progress

Frontend

Tech Stack

• Language - HTML + CSS + JS
• Framework -Vue js + Nuxt 3
• Component library - Vuetify
• State manager - Pinia
• State ORM - Pinia-orm
• Testing library (Unit test) - Vitest

Deployment

• Check here - Frontend Staging
• Hosting provider - Cloudflare pages

Backend

Tech Stack

• Language - Python
• Framework - Django REST Framework
• API specification - JSON:API
• JSON api framework - Django Rest Framework JSON:API
• Database - SQL lite (Will be changed latter)

Deployment

• Check here - Backend Staging
• Hosting provider - Railway

Authentication

Currently user need to login via RDS but this most probably will change in future

Misc

• Postman collection - Check here for available APIs
• Discord channel - Chat for goal site project
• Important Messages in discord thread

Where to find API schema?

• Go to API URL in browser
  Eg - Staging backend URL (Click here)
• Click on options button
• You can do this for every API available
• Find the API available using the postman collection