willwin4sure / otis-web

OTIS course management system

OTIS-WEB

These are the source files for the internal website that I use to teach my course OTIS. It is pretty standard Django, so you should be able to spin up a local server on a standard Unix environment.

Installation instructions

Standard Unix environment

0. Fork the repository first if you're planning on submitting a pull request later.
1. Install the following standard tools: python (version 3.9), pip, gcc, git. (For each tool, search "[name of thing to install] [your OS]" on the web.)
2. Clone this repository: git clone https://github.com/USERNAME/otis-web. Replace USERNAME with your username if you're forking; otherwise, replace with vEnhance.
3. You probably want to create a new virtual environment to avoid polluting your system with all the dependencies. If you've used conda or virtualenv or similar before, you know the drill. Otherwise, read through the steps here to create a wrapper for OTIS-WEB.
4. If things are working, you should be able to run in the virtual environment and then run pip install poetry. This enables you to use the poetry command; verify this by checking poetry --help produces a help message.
5. Once you have poetry, hit poetry install. This will install a lot of Python into your virtual environment.
6. If everything is working, python manage.py check should run with no errors.
7. Run python manage.py migrate to create the local database.
8. Run python manage.py createsuperuser to create an admin user.
9. Run python manage.py runserver. The command will spin up a continuously running server.
10. Point your browser to http://127.0.0.1:8000. You should be able to log in with the user you defined in step 7.
11. The website is functional now, but it is a bit bare-bones. To populate it with some test data, you can optionally run the command python manage.py loaddata otisweb/fixtures/testdata.yaml.

Feature requests or bug reports

Submit an issue on GitHub.

Pull requests

For OTIS students: pull requests welcome! If you think the website can be improved in some way, feel free to implement it. See contributing guidelines.

526561645265616452656164