Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/akashcraft/gradeplus
ECE 6400 Project
https://github.com/akashcraft/gradeplus
Last synced: about 2 months ago
JSON representation
ECE 6400 Project
- Host: GitHub
- URL: https://github.com/akashcraft/gradeplus
- Owner: akashcraft
- Created: 2024-09-11T03:56:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T16:40:00.000Z (2 months ago)
- Last Synced: 2024-10-23T23:18:47.403Z (2 months ago)
- Language: PHP
- Size: 56.6 MB
- Stars: 0
- Watchers: 2
- Forks: 7
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## GradePlus
ECE 6400 Project
## Installation Guide
### Software Requirements
Download and install the following software:
- [XAMPP](https://www.apachefriends.org/) (Comes with Apache, PHP, and MySQL bundled)
- [Git](https://git-scm.com/downloads) (Required - macOS users can `brew install git` if needed)
- VSCode
- Any Chromium Browser (Google Chrome, Microsoft Edge, etc.)
### VSCode Extensions
- PHP Server by brapifra (Required)
- php cs fixer by junstyle (Required)
- Live Server by Ritwick Dey (Optional)
- GitHub Copilot (Recommended - Students get free GitHub Pro)
### GitHub
You need to have a GitHub account. Please create one if you have not done so.
> [!TIP]
> For GitHub Copilot, you need to get GitHub Pro which is free for students. However, GitHub will ask for document verification which may take 2-3 business days.
Once that is done, fork this repository first and then clone it to your local machine.
Use the following command to clone the forked repository to your local machine.
```
git clone
```
### XAMPP
To run the initial boiler plate code, you only need PHP which comes bundled with XAMPP. XAMPP will be used to run the PHP server and MySQL database in the future. Here is a quick look. Just clicking the first two buttons will do the job. No need for complex MySQL or Docker setups. Again not needed for initial setup.
Install XAMPP in the root directory of your C: drive. Please add the PHP directory to user PATH during or after installation. In some cases, you may need to add to VSCode settings as well. It would be `C:\xampp\php`.
To verify your PHP installation, run the following command in a terminal window.
```
php --version
```
You should see your installed PHP version.
## Formatter
> [!IMPORTANT]
> Finally add `php cs fixer` VSCode Extension as the default formatter in VSCode Settings. This is **important**. If we do not use a consistent formatter, PRs may have incorrect indentation when you `CTRL+S` php files leading to huge unnecessary changes across the whole file.
### Running the Code
Go to the `index.php` file in the project folder. Click the button on top right or right click and select `PHP Server: Serve Project`. This will open up your default browser automatically.
You should see a green themed GradePlus website. If you see that, you are good to go. If you have any questions, please give me a tag in the discord or `[email protected]`.
Best Regards,
Akash Samanta