felixfaisal / formica Goto Github PK

Add LGM-SOC'21 score card in readme.md

The bug that you found

Currently, All the python code fails flake 8 tests, It would be great if that could be fixed

Solution (Optional)

Run flake8 tests locally and fix the issues

Type of Issue

• Code breaking bug
• Documentation issue
• Other: Fix flake8 linting

Screenshot

Include any screenshots that can assist the person reviewing the PR.

Create a way for Frontend and Backend to interact using Token Authentication

• Make GET and POST requests to get the form details, questions, and responses, then send the updated responses to the backend

Currently, The Bot folder uses three libraries
Discord.py
Python decouple/ Python dotenv
Requests
Test out any versions of it with the bot and add it to requirements.txt

• Need a workflow that ensures every contributor should follow the PEP-8 style guide for python code.
• We can use flake8 for linting and Black for formatting source code.
• Also this workflow runs on every PR which ensures the code follows PEP-8 standard or not.

Issue templates are present in this repo but there is no Pull Request Template.

@felixfaisal I'd like to work on it :-)

All the API views and oauth views along with some helper functions are jammed into views.py
Move the helper functions to helper.py
Feel free to refactor as much as you can

Add Github Action to Perform CI/CD test for

• Django
• React

Task

Describe the step by step explanation to run the project on Windows operating system.

Solution (optional)

• How to setup Docker(specifically for Home edition and Pro edition)
• npm commands
• specify API Keys if needed.

Type of Change

• New feature
• Feature update/enhancement
• Documentation

Task

Hey @felixfaisal
I would like to add code of conduct and contribution guideline to the project.
Please assign it to me.
Thanks

Solution (optional)

How do you plan to accomplish this feature?

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Screenshot(s) (optional)

Include any screenshots that can assist the person in reviewing the PR

Currently, We're using SQLite for storing tables and models
Moving to MySQL or Postgress gives more flexiblity

• Since nano will create a new file ie.env we don't need touch command in README

Task

Create a GitHub Workflow to test the docker containers working

Solution (optional)

To start the containers in dev environment use this command - docker-compose -f docker-compose-dev.yml up
Try to have this test in matrix OS that is Linux, Mac and Windows

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Task

Hey @felixfaisal
I would like to add license and project admin in the readme file.

Solution (optional)

How do you plan to accomplish this feature?

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Screenshot(s) (optional)

Include any screenshots that can assist the person in reviewing the PR

• Create a react app configured with router, redux and axios.
• Build the landing page.
• Setup navigations.

Secret key is pushed to GitHub publicly

Solution

1. Copy all the code of the settings.py to another temporary file. Remove settings.py from all the commit history, then generate a new key.

2. Create new settings.py file, paste the code from temporary file.

3. Create an .env file paste new generated secret key and import the key to new settings.py.

4. Add the .env file to .gitignore, which will stop the secret_key from getting pushed.

5. Commit the changes.

Currently, the logo was made in a hurry
We would like to have a better logo for the repo as well for the bot's display picture
Feel free to be creative about it
It would be better to discuss the wireframes over here before we have any PRs made in regards to this

Assuming the form data received on the frontend has an epoch timestamp, we could visualize the data on the frontend by displaying the number of responses received per day as a line chart or a bar chart.

The issue

Add a .env.example file for backend. I am unable to understand how to define various variables like REDIRECT_URL_DISCORD. please help me set it up.

As of now, The API's haven't been integrated with the frontend application
API's need to be added, and responses need to be used to construct user flows

Detect when a user edits their response, and update the data accordingly

Authenticate users via Discord
Store already authenticated Users information

Task

Currently, the Docker Compose copies the code into the container, It might be good for production code but it's a real hassle for development.

Solution (optional)

We could either update the current docker-compose file with volumes instead of copy or create a new docker-compose file for dev environment.

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Validate the responses we receive through the discord bot

Task

Create better documentation

Solution (optional)

Using Docusauras we can have better documentation that will allow contributors or developers to easily setup the system locally

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Screenshot(s) (optional)

Include any screenshots that can assist the person in reviewing the PR

Implement multiple choice questions, allowing the user to respond by reacting with an emoji

Context:
When a user submits a form, the bot sends an alert message to a specified channel (based on the given channel id). Right now, that channel is hard coded.

What you can do

• On the website, in the create form section, add a drop down to allow the user to select which channel he/she wants to send these alerts to (similar to the dropdown to select a server)
• Get the channel id and send to the backend
• You don't need to modify anything in the bot

Task

add some more badges to the top of readme.md file, since the badges will be colorful and more attractive at the top of README.md file than the text the users will like it and after linking the badges it will also help them to navigate to different sections/ webpages like PRs, issues, contributors, etc.

Solution (optional)

I will add some badges and also will add links related to them to the top so that the README.md file will look more interactive and awesome.

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Work under/as

• LGMSOC
• Contributor

The discord oauth login in the backend needs to be integrated in the frontend
Redirecting of routes should work

Task

Describe the step by step explanation to run the project on Linux based OS

Solution (optional)

• How to setup Docker
• npm commands
• specify API key if needed.

Type of Change

• Feature update/enhancement
• Documentation

Add program section in readme.md to represent that this project is a part of LGM-SOC'21

Add a dockerfile to the bot and test it out
Add it to services in docker-compose.yml

Task

I would like to add contributors sections in readme

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Screenshot(s) (optional)

After the git clone in the next step there is " cd attack-on-web ".

Create a discord bot that:

• Sends embedded messages
• Responds to commands
• Detects emoji reactions
• Allows a user to fill in a form via DM
  • Sends 1 question at a time, waits for a response, then sends the next question

Create dockers container for the Frontend, Backend, Discord Bot and MySQL
Interact with each other
Create volumes for development environment

Create an issue template for two types of issues

• Bugs
• Feature Request
  Feel free to be creative about it

Setup a RDBMS table
Creating form
Form Response

• Documentation issue
  • Adding the Contributors section in the README.md to display all contributors of the project.
  • It can be next to the Project Admin section.

Do assign me under LGMSOC'21.

Task

Create a GitHub Workflow to publish images to DockerHub

Solution (optional)

You can find resources on how to publish docker images online, For any assistance you can contact me

Type of Change

• New feature
• Feature update/enhancement
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation
• Other: Please describe

Screenshot(s) (optional)

Include any screenshots that can assist the person in reviewing the PR