Skip to content

StephenXie/ProjectAlpha

Repository files navigation

ProjectAlpha

Build Status Django CI License: GPL v3 Website StephenXie.com Commit Activity GitHub issues GitHub issues GitHub pull-requests GitHub pull-requests

Where can I find this AWESOME website?

Go to https://www.stephenxie.com/ or https://sx-my-app.herokuapp.com/.

React website under construction

We are currently trying to use React.js to redesign the frontend, the code can be found in the development-react branch. The website is currently hosted at http://dev.stephenxie.com/.

Wiki

Go to the Wiki page for more information about this project

Resources

Tailwind Documentation - Documentation for tailwind css and how to use it
Tailwind Kit - They have some nice css components
Django Documentation - Documentation for django, pretty useful
Heroku Postgres - How to use the database

Local usage

Make sure you have python 3.6 or above

First, install all of the dependencies needed

pip install -r requirements.txt

To run, enter

python manage.py runserver

File structure

  • Todo, Formatter, Cryptic, GPAcal, PasteX, Linky - apps
    • Views - the main thing handling the the get and post requests
      • Can pass arguments to the html
    • Scripts - what you do with the inputs
      • Interact with the views
      • Logics
    • Models - database stuff
  • Templates - contains htmls
    • HTMLs - what user actually sees
    • base.html - the template html file so that we don't have to copy and paste everytime we make changes
  • AppX - Home page
  • ProjectX - Settings
    • url.py - url of pages
  • Static - Assets(e.g. images, css, js)

GPA Calculator

  • add and delete class button
    • implemented using JS and JQuery
    • [new] using react components
  • input fields: class name(optional), grade, credit, weight
  • using AJAX to update GPA when the form is changed without refreshing the page
    • using jQuery
  • all button and input fields are powered with some nice CSS
    • currently using Tailwind CSS
    • might switch to bootstrap later
  • part of a student advisory center concept
    • college preparation
    • precentile finding
    • let user select what college they wanted to go to
      • gather dataset from colleges
      • show how users' GPA compare to other candidates
      • possibly implement goals/"tracks" the user should follow to reach their goal. (i.e: how they need to improve their grade to reach certain GPA, etc.)