liuqingli / twirole-django

Website for the classifier.

twirole-django

Website for the classifier. This website is ordered in a typical Django project fashion.

This project is meant to run under pipenv. If you choose not to run under pipenv, you can install the packages as specified in the Pipfile in conda, or raw via pip.

Getting started (development)

This project requires a few things to be installed:

1. Pipenv
2. NPM
3. Python 3.7+

Now run the following commands from this directory:

1. pipenv install
2. npm install

This will install everything needed to launch the server and develop.

File hierarchy

The project is organized into 5 folders.

api - A Django app that contains code pertaining to the API. Exposes a GraphQL endpoint and contains functions to call the TwiRole model (see: twirole.py).

assets - The static assets directory. By default, these are served on /static. Contains Javascript libraries, CSS, and some images such as the spinner and TwiRole logo.

page - A Django app that contains page-serving code. This currently only serves one route, as you can see in views.py.

project - The project configuration folder. This contains the settings.py file, which is used to configure the project. MAKE SURE TO SET DEBUG=False

templates - The HTML template files. Currently, index.html is the only file that is served, but it is composed of many templates in partials.