kwickerhub / backend

The ACES software aid backend repo

backend

The ACES software aid backend repo To reduce the stress of having to understand everything, please watch this video before you contribute to this project: https://youtu.be/zBRju-UY83U It is also proper that you clone the frontend Repository of this organisation for you to have a better visual understanding of your Backend lines of code.

SET-UP

To set-up, import the sql file into your local database system(like PHPMYADMIN).

Info

Every table has a unique folder that controls it's manipulation. But not all folders represent tables. Every Folder representing a table has different kinds of functions that can help you select from the Database.

The 'the_connector' Folder contains login details to the Database. It contains the Database name, username and password.

The 'hashing' Folder contains functions that can help you in hashing strings or user data. We will be using BCRYPT on the user password after salting it.

The 'generator' Folder contains functions that can generate different kinds of strings or integers. The generated string or integer is mean't to be unique and will be used in the user verification.

backend's Issues

Make a Profile Endpoint for the Frontend Repo

We will love to get details about a User as to make his/her Profile page dynamic.

GOAL
Give a user id
We should produce more details about the user

output = {
status: successful,
user: [id: 2, username: somebody etc],
modules: 40, 50, 67,
projects: 2, 30, 102, 
msg: Connection completed,
}

the numbers in the modules and projects section represent the module and project ids respectively.

Documentation

We need proper documentation of this repository.
Dev Documentation
All the files and the different thing the files do so that it will be easy for other developers to contribute.

User Documentation
The different endpoints and the different kinds of data feedback the endpoints provide. Some provide JSON structures, strings or raw html content.

Create the Folder before Creating the file

File = "projects/add_project.php"

Instead of creating a new file alone, We should create a new folder and then create the file inside the folder.

Aim: This will help us create a system render of files and other folders inside that particular project for the end-user.

We can call the file "index.html" and maintain the project_location name(code line 22) for the folder, In order to make every folder very unique. (Remember that folders do not have an extension)

adjust line 50 of get_elements.php

Some variables in line 50 are not defined. Your Job is simple: Just remove the undefined variables and make sure that the content the array is sending out are the parameters in the query.

Create an File that will be able to Insert Modules to the DB

Getting Examples from

"attribute/insert_attribute.php" &
"style/insert_style.php"

Create a "assistance/insert_assistance.php" for users to upload their modules.

Load a Saved Project

if given a project_id or project_name, Adjust the load_saved_content.php to locate and return the given project content.

Get Data For File Explorer Display

We want to create an endpoint in the "projects" folder where we can communicate with the Front-end Guys to inform them of the current files and folders in a particular Project.

GOAL
Give a Project Id
We will produce a JSON structure of the files and sub-folders in that particular project directory.
e.g

output = {
status: successful, 
project: [ file: index.html, folder_name: [file: javascript.js] ] 
msg: No problem in connection and the Project details have been sent.
}

Get Assitance/Modules from the Database - "get_assistance.php"

Inline with issue #12 we will then need to write code to the "get_assistance.php" file to be able to display details about the Different modules or assistance tools on the database that was earlier entered by users around the world.

Get inspiration from:
"style/get_style.php" and "attribute/get_attribute.php" endpoints.