https://github.com/tangledhelix/tealdb

Light It Teal's lightings tracker
https://github.com/tangledhelix/tealdb

Last synced: 19 days ago
JSON representation

Light It Teal's lightings tracker

• Host: GitHub
• URL: https://github.com/tangledhelix/tealdb
• Owner: tangledhelix
• Created: 2020-05-19T19:00:27.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-27T21:43:34.000Z (8 months ago)
• Last Synced: 2024-04-27T22:30:08.090Z (8 months ago)
• Language: Python
• Homepage:
• Size: 91.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

## Requirements ##

Requirements are:

- Python 3

- The Python stuff found in `requirements.txt`

- Javascript stuff managed via [Yarn](https://yarnpkg.com)

## Resources used in this project ##

- [Python 3](https://www.python.org/)

- [Django](https://www.djangoproject.com/)

- [Bootstrap](http://getbootstrap.com/)

- [jQuery](https://jquery.com/)

- [django-yarnpkg](https://pypi.org/project/django-yarnpkg/)

## Secrets

A few things are kept in `turnitteal/secrets.py`. (See `secrets.py.example`.)

## Setup for dev/testing ##

### Install requirements ###

If you're using venv, start with this:

```

# This command may be 'python3' or 'python' depending on your system

# (If you have both, then use 'python3')

python3 -m venv venv

. venv/bin/activate

```

To install everything:

```

python -m pip install -U pip

python -m pip install -r requirements.txt

python manage.py yarn install

python manage.py collectstatic

python manage.py migrate

```

(Assumes you have created a `tealdb` database with user `tealdb`

and a password matching `turnitteal/settings.py`.)

You'll need to create a superuser to log in as:

```

python3 manage.py createsuperuser --username dan --email [email protected]

```

And then enter a password twice to set it.

### Update static components ###

To update the version of Yarn resources, or add more, look at

`YARN_INSTALLED_APPS` in `settings.py`, then:

```

python manage.py yarn install

python manage.py collectstatic

```

For statically-defined resources you manually manage under `{APP}/static`,

manage the file like normal, and then run just the above `collectstatic`

command to assemble all the static resources in one location.

You can call other yarn commands similarly, if needed. See here for more

on the django-yarnpkg integration: