subsonicgroupfinder / sgf-legacy

The repository for the Subsonic group finder web app. Written with Django Python and React. Uses MySQL

THIS REPOSITORY HAS MOVED!

This repository is no longer in active development and will soon be made read only. FIND THE NEW REPO HERE:

https://github.com/SubsonicGroupFinder/SubsonicGroupFinder

SGF-web-app

The aim of this project is to produce a cross platform looking for group app or LFG for short. It is called Subsonic Group Finder and will be aimed at gamers so will have a number of functions that will allow users to find other players on their platform and game so that they can play together. We are currently working on a web app that will have feeds showing who is looking for a group and allow users to filter the feeds to find what they are looking for.

This project is a group project, though it was started by Subsonic-dev.

Acronyms

• LFG- Looking for Group
• 2FA- 2 factor authentication
• SEO- Search Engine optimization
• SGF- Subsonic Group Finder

Goals

• Clean, sustainable, code that can be passed on to the next person
• Team cooperation
• Respecting everyone's abilities and ideas
• Learning new things
• Fun

Tech Stack

• Python3 Django for the backend ** All apps in django are api's there are no templates
• React, HTML, CSS, JS for the front end
• Database - SQL/mySQL

Dev Environement

• make sure that you have python3 installed
• as well as react, node, and npm
• the virtual environment for the backend is handled with pipenv
• so do some version of sudo apt-get install pipenv
• clone the repo
• cd SGF-web-app
• cd backend/
• pipenv install
• pipenv shell
• cd webapp_api
• python3 manage.py runserver
• cd ../..
• cd frontend
• npm install
• npm start

Backend:

After you activate the enviornment and get there server running here are the endpoints we have at the current moment:

• http://127.0.0.1:8000/api/v1/custom/register/

• http://127.0.0.1:8000/api/v1/custom/verify-email/ - Not Valid Yet

• http://127.0.0.1:8000/api/v1/custom/user/

• http://127.0.0.1:8000/api/v1/custom/login/

• http://127.0.0.1:8000/api/v1/custom/logout/

• http://127.0.0.1:8000/api/v1/custom/password/reset/ - Not Valid Yet

• http://127.0.0.1:8000/api/v1/custom/password/reset/confirm/ -Not Valid Yet

• http://127.0.0.1:8000/api/v1/custom/password/reset/change/

Note: you may have to do some migrations stuff for django to get the things working

If things get weird don't be afraid to delete the migration in users and the sqlite db. *** This is fine for now but once we get rolling do not touch the migrations***

This should start both of the servers that you need to have going. The backend will be on localhost:8000 and the frontend will be on localhost:3000. The back is only an api.

This is just a start to get the environment set up, meaning that the only react files are for "App" App.js is the file that has been edited.

sgf-legacy's Issues

Create a Post

Module needs to be written for Creating a Post.

Please assign it to me @rr-phillips

Admin Functionality for moderating posts

an extra tab in the account section, or in the main menu?

Questions

• what will the power of moderators be?
• what will the posting process look like if we're having moderators?
• how will moderators be chosen?
• who will make those choices?
• what recourse will there be for bad moderators?

create sign-in api endpoints

• verification of password
• verification of email
• updates user info, such as last login

An exception while registering a new user.

There is an exception while creating a new user.
That's the initial report. Digging deeper inside.

Thanks!

@rr-phillips @Subsonic-dev

Test issue for discord webhook

This can be ignored :)

Search Engine Optimazation

This will be easier to do from the beginning.

I'm not personally too familiar with these services, so we'll have to research then discuss and implement.

create forgot password endpoint

create comment model

• create comment model
• test on a post through api

Allow the user to filter posts by tags we set

Allows the user to filter posts in the feed out of a set list that we define. Common tags like platform Xbox, Playstation, PC etc as well as a list of games eg Ark, No Man's sky etc.

Creating New User form bug

The form for creating a new user does not accept any input. The same issue was with login form but that is now fixed.

Ads implemented

This should only be considered if the cost of maintenance becomes a problem.

If we decide to place ads, I would like to all discuss which ads we will take and how will will implement

Front end things to do

• profile page
• get links working
• footer
• terms of service
• privacy policy
• add conditional to logged in users
• login btn changes to logout
• register btn goes away
• profile link gets added (not displayed until someone is logged in)
• my groups link gets added (not displayed until someone is logged in)

Users make an account

Users will be able to make an account with the standard information - email, username, password, confirmation password.

• registration page
• sign-in page
• sign-out functionality
• forgot password page
• basic account page that shows email, username, and has a portion for changing password

Create A Logo

create a logo to be used in the header, as well as for a favicon

• logo
• favicon

User can create clans/groups

Any user will be able to make a clan/group.

Questions to answer:

• will there be any requirements that will turn this on and off? like reputation, or time on platform or something?
• what special privileges does being a group/clan leader give you vs. a group member?

Add bot proctection to posts

aka recaptcha implementation for all forms (posts, signing up, forgot password, ect.)

Migrating from Django to FastAPI

User groups or clans

This will encompass all of the feature for the user's clans/groups

• #5
• #6
• #7

Long term discussion: Privacy respecting monatisation and site upkeep (Topic for future consideration)

As of writing this there is no real need to look at this yet as we are still very far away from needing to implement things like anti ad blocking and therefore actual ads .

I don't think it is possible to have ads that respect privacy based on the whole concept of adverts meaning we would need to consider other ways of covering upkeep costs. Think of long term is donations so either paypal or truly embracing open source equivalents like Libre pay, having donator perks like special coloured titles or badges on user profiles etc etc.

This is not to be answered just now and is intended to be a long term discussion for when these topics come up.

create update password endpoint

DeepLinks to mobile app/desktop app

Make sure these are easy to find but unobtrusive

create a design

create a design to base the ui/ux off of.

• choose color
• choose design
• choose typography

create get user posts endpoint

Communicate With SS Widgets

Should be able to communicate with potential widgets on the Subsonic Syndicate website

Anti-ad blocker

If we have ads, we should check that people aren't ad-blocking

set up the sql database

set up the database on the server

Accout registration/forgot password forms

• 2FA (2 factor authentication)
• strong passwords
• recaptcha

Create user model, and serialize

• create user model
• serialize
• being able to sign up via api

create update email endpoint

User Policy/Terms of service

This will be a big thing

create get user endpoint

• create endpoint that gets user by their id and returns account info

Account linkage

We should add a feature that allows integration for users to link certain gaming accounts like:

• Xbox Live account
• PSN accounts
• Steam/COG
• Nintendo?
• Discord for easier integration with the webhooks

I am unfamiliar with if some of these platforms allow access to their login apis but I believe it should be possible. Adding for future consideration.

New Post - Not Accepting Inputs

New Post - Not Accepting Inputs

@rr-phillips @Subsonic-dev
Please assign

create sign out endpoint

• clears user and permissions from session

Implement Swagger

Implement Swagger with complete documentation of APIs

Communicate with Discord Bot

This is eventually going to happen when we make the discord bot, but it is a low priority

Come up with basic design for front end

As per pm meeting a task for me to complete. This is a reminder and will be updated when deadlines approach.

Login Form not accepting Username and Password

Groups/clans have their own LFG feeds

Posts should have tags

Questions

• will users be able to make their own?
• will these also have the profanity filter?
• how many will be allowed?

add the backend into the server

put the django backend on the server so we can all use the same one

LFG posts should have a profanity filter

aka no LFG posts are allowed to use profanity, and there will have to be a check for them before allowing the post to submit.

this HAS to be in the TOS

Questions:

• will there be profanities allowed in the group/clan posts?
• will repeated attempts to use profanities result in some sort of penalty? removal?

LFG posts

url name: getPosts
form/content of post should include:

front end form

• platform
• game
• tags
• body
• title

back end form

• platform
• game
• tags
• body
• title

Group/clan leaders can moderate their clans

This includes:

• approving membership
• moderating content
• removing group/clan status from users
• closing the group/clan

Questions to answer:

• Will there be the ability for the owner of the group/clan to assign "moderator" status to other members
• What can the members do if they have a problem?

Design a user profile section

WIP for what a users profile could look like.

Features:

user icon
username
social icons for linked accounts
account age
any badges