real-dev-squad / website-goals Goto Github PK

Currently when running dev mode, we have to manually redirect port 3000 to 443 using something like

npx local-ssl-proxy --source 443 --target 3000

For us to run the website in custom local domain and avoid CORS error. Read more about cors

We want to automatically redirect port 3000 to 433 when running

yarn run dev

You can check the setup at website-my for reference

If you face any problem please message in #🔮goals-site-vue

• Setup Pinia

• Setup Pinia-orm

• Setup User repository, model, interface and adapter

• Setup Goal repository. interface and adapter

• Setup UserGoal repository, interface and adapter

• Setup goals modal

Sidebar navigation options

• Home
• Self goals
• All goals

Example -

Required Name -
Goals | Real Dev Squad

User Story

• As a user, I should be able to view all public goal to keep thing transparent.
• As a user, I should be able to view all goals assigned to me in a click.
• As a user, I should be able to create a new goal for myself.
• As a user, I should be able to edit my goals.

Super user

• As a superuser, I should be able to view all public goals.
• As a superuser, I should be able to filter/sort based on created at, status, and assigned to better keep track of goals.
• As a superuser, I should be able to create new goals with just the title of goal to keep things convenient.
• As a superuser, I should be able to assign people goals.
• As a superuser, I should be able to update the details of any public goal.

As a superuser, I should be able to create goal templates, to reuse goal details.

Authentication Flow

• (Django) Goal Authentication middleware
• (Vue) Frontend authentication sync
• (Node js) RDS backend sync
  

Authorization

• Authorization middleware

E.g I am in Pacific time, and I see IST

• Authentication provider for rest of the system to use

On the API's end, we are using Django.
Setting up testing for the project.

1. When clicked on 'Open source repo' at the footer of https://goals.realdevsquad.com/ it gets redirected to Member site repo instead of goal site vue repo i.e https://github.com/Real-Dev-Squad/website-goals.

2. Remove that code Fragment from the link too.
   

• Upgrade to Nuxt 3
• Upgrade to Vuetify 3 (necessary)
• Upgrade to Pinia (recommended)

Enabling Dark Mode for Goals site
working member - Pavan

Sample picture of Welcome site before and after enabling dark mode attached for reference

Before -

After -

Types

Goal

id; String
title: String
description: String
type: String
resources: Array
createdBy: Timestamp
createdAt: Timestamp
access: Array

UserGoal

goalId: String
userId: String
startOn: timestamp
endOn: timestamp
percentageCompleted: Integer
assignedBy: String
status: String
deferUntil: timestamp

Advantage

• Goals should be reusable
• Should be as configurable as possible
• Data should be normalized
• User model shouldn't be affected

Design Link: Figma

Mock Service Worker (MSW) is a seamless REST/GraphQL API mocking library for browsers and Node.js.

Target

• Create Goals by super_user.
• Assign goals to different users by super_user. Goals should be reusable.
• Display list of goals to user.
• Mark as complete by app_owner or super_user.
• Standard RDS Navbar.

Guidelines

• Use atomic components following RDS design system.
• Tests must be included in the same PR.
• PR should as small as possible.

Issue

• When a PR is created, the git workflow runs tests on all the pull requests, but once the tests are run on pull requests they run again during push

When was the issue discovered?

• The issue was discovered on 18th August 2022 during a hangout call while trying to merge PRs.

Files that might be creating this

• .github/workflows/test.yml

Screenshot of the Problem

-To check for the list of packages which are being used in package.json and upgrade it to the latest available version.
-Also verify if the build remains stable after upgradation.

Can we please put a title like Goals | Real Dev Squad? Because we are following this pattern for members and status sites too. So keeping the pattern same will be good.

Originally posted by @RohitKuwar in #18 (comment)

Create a documentation explaining steps to make a pull request in goals site.

A text field where user can create goal by just entering the title.

Navbars on different sites(sub-domains of RDS) are different as of now.

We need to make it look similar and familiar to the user. So we are going to redesign it.

Design of New Navbar:

https://www.figma.com/file/bpFHG9hXM13GSLmTkoNsrF/Navbar?node-id=0%3A1

For CSS, refer to the link below

https://github.com/Real-Dev-Squad/website-www/blob/develop/css/navbar.css

Few Details

• font : Roboto
• weight: 700
• active color : #49A82E
• hover color : #49A82E
• font size : 16 px (try making it in rem)
• active underline height : 3px (color : #49A82E)

Pay Attention

=> Underline should be under the text as shown in the image and not inside the container in which the text persists.
=> Underline should be only under the active tab, it should not be visible on hover.
=> The full navbar should be changed to the toggle menu when the screen width is less than 970px.
=> User should be directed to my.realdevsquad.com on clicking User Greet

There might be slight changes for different domains and you are free to ask in the comments for that

Refer to Real-Dev-Squad/website-members#265 for more insights.

• Install Husky
• Setup husky
• Setup auto lint

Since this codebase has been not updated for a while, please update all the packages to use what the official setup recommends.

Also, please update the config to start using TS here.

DTO change Real-Dev-Squad/backend-goals#2

The repo has a nested folder for source code. Is there a reason for it?

template to be used

### Issue:

### Description:

### Anything you would like to inform the reviewer about:

### Dev Tested:
- [ ] Yes
- [ ] No

### Put the Feature behind Feature Flag
- [ ] Yes
- [ ] No

### Test Stats

### Images/video of the change:

### Follow-up Issues (if any):

> NOTE: After your PR is merged in main please verify its working on prod and raise a dev to main PR

For reference on how to do the same, you can check website-status

NOTE: If you face any problem please message in #🔮goals-site-vue

Add goals option in goal site.

Example

Things that needs to be setup.

• Django backend
• Enviroments
• JSONAPI django framework
• Relational database (SQL)
• Add more..

https://docs.volta.sh/guide/understanding

You can refer: Real-Dev-Squad/website-backend#468

What has to be done

1. Add a brief description of the purpose of the website

2. Add the deployed link to the website

3. Add a link to the contribution doc

Refer to how it is done here

https://devcenter.heroku.com/categories/working-with-django