hitk-tech-community / community-website Goto Github PK

Deliverables :

• Implement this broadcast design using material UI library
• use this color pallete

We need a link shortener service which accepts a query parameter link and shortens it to a code of length 5. One using that link it should redirect to the original link if valid; else throw a proper error.
Use collection shortLinks for storage

API testing required for this.
For API testing briefing refer to #81

Hi,
I found that this project repository is not having a code of conduct file in this repository, kindly assign me this issue and I would like to contribute a well-formatted code of conduct file as you know code of conduct is a necessary file which the contributors need to follow so that everyone follows a decorum.

As we are almost ready with the UI. We need to decide the color pallete that will be followed while implementing those designs.

This issue is focused on having the discussion on color pallet and it's finalisation.

Feel free to drop your pallete suggestions in the comments below.

• Add initial structure for frontend using react having basic components

Issue Description:

• Click on admin? button and see the login screen. It's not appearing properly.

Deliverables:

• Fix the login screen.

• Make sure to have a better UI and try to use this color pallet whereever required

Task

Check out the backend-setup branch, go through the codebase. Play around the codebase. Try to find bugs in the codebase.

How to report a bug

Once you find a bug, create a new issue and tag the mentors @jackfrost13 @Kajol-Kumari with the following pieces of information.

• Description
• Steps to reproduce the bug
• Cause of the bug
• Possible solutions

This issue can be assigned to multiple people

Special points for finding bugs

The color of icon in the form of 'Contact us' page is grey

The color of icon in the form of 'Resource' page is dark(black)

• Make UI for the broadcast of the website using any of the UI designing tool like figma

• Make UI for the contact us page of the website using any of the UI designing tool like figma

Make the footer component more attractive and lively and also add a Newsletter column to it.

We must have a community user model and respected routes so that we can fix functionality we are going to provide for a particular user in our community.Isn't It?

@Kajol-Kumari
Windows operating system

install npm install [email protected]

'React' must be in scope when using JSX error due to not using
import React from 'react'
import ReactDOM from 'react-dom'

There would be a login and signup screen only for admins so in this PR.

We need the Frontend pages for

1. Login
2. Signup

In this issue, we want to revamp the home page having better header, footer and home page content by following this color pallet.

Deliverables:

• Better Header { Just keep home, Contact Us, Broadcasts, Resource Share, About Us, FAQ in the header section along with admin? on the right side of the header }

• Better Footer { Use better logo for social media handles, add a line All right reserved by @Hitk-Tech-Communty or Made with :heart: by HITK Tech Community in the footer.}

• Better Home page Content { This page should include a brief about who are are (put dummy text as of now) along with our motive(put dummy text as of now) in most attractive way possible }

• Add basic backend server having main route file, index file and separate folder for controllers and middlewares.

Deliverables:

• Make separate navbar for admin taking reference of this design

• Make the admin home page, taking reference from this design.

• Make /admin route that will direct to the admin's home page

• Use this color pallet

• Make a separate folder under component and put all the codes there

• Improvements are welcomed :)

Deliverables:

Make the FAQ page for the community website with design similar to this following this color pallet.

If you can make it more standard and attaractive, that would be much appreciated :)

Deliverables:

• A good enough PR template that contain all the required sections including which issue it closes closes #issue_num, Feature/changes introduced through the PR etc.

• API for allowing users to signup as admin and only after admin approves that person, he/she will be given admin previledges.

There won't be any signup/login for normal users

• Add header and footer as reusable component so that It can just be rendered wherever required.

Dependent of issue #3 [ First This issue needs to be resolved ]

Deliverables

• Add welcome bot config file having proper message that will show up when any user will open up an issue or pull-request for the first time.

For reference, checkout https://github.com/apps/welcome

For the Frontend part, you have mentioned this step in order to install the project on our machine. I have just added the second point because after navigating using cd Community-Website we cannot do directly npm install and also changed the file name.

1. Navigate to the community-website folder using cd Community-Website.
2. cd frontend
3. Run npm install. It will install all the required packages and dependencies.
4. Run npm start to run the server.
5. Navigate to http://localhost:3000 to view it in the browser.

Make UI for the FAQs page of the website using any of the UI designing tool like figma

This page will contain the list of all frequently asked questions along with their answers.

There would be a separate page for admins only:

1. Home page
2. Settings Tab [ for approving users as admin ]
3. Manage Broadcast page

Any other basic tabs that an admin is expected to have.

In the frontend section write path cd frontend , instance of cd community-website. Modify it!

• The logo that we currently have doesn't fir for our website, so a new logo is required which will look better as icon for our website

Deliverables:

• Template for bug report issue containing all the required the sections like {Current behaviour, expected behaviour, Related screenshot, Device used etc}

• Template for feature request issue containing all the required the sections like {Feature description, Related link.screenshot for referrence etc}

Description

Prepare documentation for the initial backend setup.
Check out the backend-setup branch, go through the entire codebase, and prepare well-descriptive documentation that will be used for the wiki page of the project.

It will be a unique experience as you get a chance for 1-1 interaction with the mentors. We would love to share our experiences and exchange knowledge with you.

This issue will call for several revisions and discussions. Please feel free to contact us via slack.

This issue can be assigned to multiple people

• Make UI for the about us page of the website using any of the UI designing tool like figma
  It should include a brief about who we are and the details of the team working behind the scene

I have forked the project , but If I make any changes I need to restart the server again and again.
I want to edit the project readme so that everyone doesn't face the same problem. Please assign me to work on this issue .
with tag DWOC

Deliverables:

• Better deisgn to FAQ page
• Remove all the inline styles from faqs.js file and put it in a new file named faqs.css and just use the classNames in JS file

Adding documentation for issue creation and PR creation in pre-existing file contributing.md (in case new file creation required, please suggest a name). Extension to #75 and #76 issues. Will work on it as soon as assigned.

Currently the carousel section have very large image height. Fix it to better smaller sized posters content

Description

API Testing for the admin route using Postman. There should be one collection for login containing multiple requests covering all the major tests for admin login route.

Examples:

• Invalid request body test
• Successful login
• Invalid password

Requests must be accompanied with pre-request scripts, tests accordingly where ever required

One should be able to run the collection N number of times in the collection runner.

Admin Login Route

• [POST] /auth/login

• Request Body

  Parameter	Description
  email	string, required
  password	string, required

• Response contains JWT Token

Resouces

• Postman Learning Centre
• YouTube Intro to Postman
• Writing tests in postman

• Make UI for the home page of the website using any of the UI designing tool like figma

Make a contributing.md file and add the guidelines for contributing to this project. You can refer this for the same ad make the required changes in here.

Deliverables-

• Make the navbar responsive for different screen sizes
• Fix the menu option hover effect for smaller screens
  

Work to be done:

• Add a route for creating admins.[POST]
• Validation Schema for the request body
• API Testing using Postman demonstrating all possible cases(valid, invalid) with test cases

Request Body Structure:

NOTE: Please go through the backend code to get a feel of the code structure and follow that.

For API Testing briefing, refer to #81

• The login page is distorted and needs to be fixed

Make a code_of_conduct.md file in the project and add the contributor guidelines in here.

Reference link - https://www.contributor-covenant.org/version/1/3/0/code-of-conduct/

Tech stack discussion for the official website of the community.

• Make UI for the resource sharing page of the website using any of the UI designing tool like figma

This page will include a brief introduction and a form with the fields same as this form.

Work to be done:

• Add a route for changing password. [PUT] /admin/password
• Validation Schema for the request body
• API Testing using Postman demonstrating all possible cases(valid, invalid) with test cases

Request Body Structure:

NOTE: Please go through the backend code to get a feel of the code structure and follow that.

For API Testing briefing, refer to #81

Deliverables:

• Make the resource sharing page having a form with the fields same as this
• Use this color plattet for implementing the design

Deliverables:

• Make the contact us page of the community-website following this design and this color pallet.

If you can make this page preetier and consistent, it would be much appreciated :)

We need a helper function capable of sending emails. It should accept the necessary fields like recipient list, body, subject etc.
The configurations for email service should be in the config folder. We will also need an emailTemplates.json file which will contain the templates so that one can select a template and roll out the email without hardcoding the email matter.
For starter make one template named inviteAdmin which will be used to for inviting someone to be an admin.

One needs to incorporate dynamic variables for emailTemplates

Let me know if you have any queries.

Deliverables:

• Keep the header same as current one and make the rest of the page structure including footer as per the deisgn here
• Make Sure to use this pallet

update:
Everyone, working on this issue, please try to implement the meet the crew section from this design

Work to be done:

• Add a route for updating admin profile.[PUT] /admin
• Validation Schema for the request body
• API Testing using Postman demonstrating all possible cases(valid, invalid) with test cases

Request Body Structure:

NOTE: Please go through the backend code to get a feel of the code structure and follow that.

For API Testing briefing, refer to #81