Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/valasek/kicoma
Kitchen management software
https://github.com/valasek/kicoma
django django-cookiecutter heroku kitchen-management python
Last synced: about 1 month ago
JSON representation
Kitchen management software
- Host: GitHub
- URL: https://github.com/valasek/kicoma
- Owner: valasek
- License: gpl-3.0
- Created: 2020-04-03T22:33:20.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-09T15:54:47.000Z (5 months ago)
- Last Synced: 2024-10-02T09:14:08.419Z (about 1 month ago)
- Topics: django, django-cookiecutter, heroku, kitchen-management, python
- Language: HTML
- Homepage: https://kicoma-tri.herokuapp.com/
- Size: 1.91 MB
- Stars: 3
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
KiCoMa - Kitchen cooking management
==================
[](https://github.com/valasek/kicoma)
[](https://github.com/valasek/kicoma/issues)
[](https://travis-ci.org/valasek/kima) [](https://github.com/pydanny/cookiecutter-django/) [](https://github.com/ambv/black)
## Demo
Check the lastest version at [kicoma-tri.herokuapp.com](https://kicoma-tri.herokuapp.com).
## License
All source code in the [KiCoMa](https://github.com/valasek/kicoma) is available under the GNU GPL v3 License. See [LICENSE.md](LICENSE.md) for details.
## Data Model
# Useful Commands
## Reset Development DB
`./reset-db.sh`
## Reset Heroku DB
`./reset-db-heroku.sh`
## Check the production settings
./manage.py check --deploy --settings=config.settings.production
## Generate DB model
Using https://django-extensions.readthedocs.io/en/latest/graph_models.html
* `python3 manage.py graph_models -a -g -o datamodel.png` or
* `python3 manage.py graph_models kitchen -g -o datamodel.png` and copy the file to statics/images
## Update Translations
### Generate message files for a desired language
`./manage.py makemessages -l en -l cs`
### After adding translations to the .po files, compile the messages
`./manage.py compilemessages`
# Deploy to Heroku
## Update
`heroku login`
## Update
`git push kicoma-tri master`
`git push heroku master`
## Usefull heroku commands
`heroku git:remote -a kicoma-tri`
`heroku apps:info -a kicoma-tri`
`heroku apps:stacks -a kicoma-tri`
`heroku buildpacks -a kicoma-tri`
## Generate user password for fixture
`./manage.py shell`
`from django.contrib.auth.hashers import make_password`
`make_password('password')`
## External dependencies
* Python
* Django
* Postgresql
## Getting started
To get started with the app, clone the repo and then install Python 3:
```
$ cd ~/tmp
$ git clone https://github.com/valasek/kicoma
$ cd kicoma
```
Install docker and docker compose and run
`docker-compose up`
DEPRECATED - local dev server
Create python virtual environment, tested is python 3.10.2
`https://towardsdatascience.com/python-environment-101-1d68bda3094d`
`python3 -m venv `
Switch to the virtual environment:
`source ./env/bin/activate`
Install dependenciec
`pip install -r requirements/local.txt`
Install PostgreSql, I use Postgres.app and PgAdmin as a client
Create DB with a name kicoma
migrate the database:
```
$ ./manage.py makemigrations
$ ./manage.py migrate
```
Finally, run the test suite to verify that everything is working correctly:
```
$ ./manage.py test
```
If the test suite passes, you'll be ready to run the app in a local server:
```
$ ./manage.py runserver
```
Getting up and running locally:
https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html
## Reset DB
`./reset-db.sh`
Settings
--------
Moved to settings_.
.. _settings: http://cookiecutter-django.readthedocs.io/en/latest/settings.html
Basic Commands
--------------
Setting Up Your Users
^^^^^^^^^^^^^^^^^^^^^
* To create a **normal user account**, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.
* To create an **superuser account**, use this command::
$ python manage.py createsuperuser
For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.
Type checks
^^^^^^^^^^^
Running type checks with mypy:
::
$ mypy kicoma
Test coverage
^^^^^^^^^^^^^
To run the tests, check your test coverage, and generate an HTML coverage report::
$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html
Running tests
~~~~~~~~~~~~~~~~~~~~~~~~~~
./manage.py test kitchen
::
$ pytest
Live reloading and Sass CSS compilation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Moved to `Live reloading and SASS compilation`_.
.. _`Live reloading and SASS compilation`: http://cookiecutter-django.readthedocs.io/en/latest/live-reloading-and-sass-compilation.html
Deployment
----------
The following details how to deploy this application.
Heroku
^^^^^^
## Initial set-up
https://cookiecutter-django.readthedocs.io/en/latest/deployment-on-heroku.html
Managing Multiple Environments for an App - https://devcenter.heroku.com/articles/multiple-environments
Do not forget to add the following argument at the end of every command:
` --app `
``--app kicoma-tri`
## Set email domain
`heroku config:set MAILGUN_DOMAIN=hospic-cercany.cz`
## Initialize DB
`./reset-db-heroku.sh`