haldis/README.md

Haldis
=======
[![chat mattermost](https://img.shields.io/badge/chat-mattermost-blue.svg)](https://mattermost.zeus.gent/zeus/channels/haldis)
[![Website](https://img.shields.io/website/https/haldis.zeus.gent.svg)](https://haldis.zeus.gent)
[![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/haldis.zeus.gent.svg?publish)](https://observatory.mozilla.org/analyze/haldis.zeus.gent)

![GitHub commit activity](https://img.shields.io/github/commit-activity/y/zeuswpi/haldis.svg)

Haldis is your friendly neighbourhood servant. He exists so lazy fucks like you and me don't need to keep tabs of who is ordering what from where.
Start an order and let people add items with a simple mouse-click!
No more calculating prices and making lists!
Be lazier today!

## Local setup

There is a special script to get started with the project. Just run it in the root of the project.

    ./first-setup.sh

This will create a virtual environment, install the necessary dependencies and will give you the option to seed the database.

If you are using a database other then sqlite you will first need to configure the correct URI to the database in the generated 'config.py' file.
Afterwards upgrade the database to the latest version using

    cd app
    python3 app.py db upgrade

You can now still seed the database by running

    ./populate-db.sh

in the root folder of the project.


Activate the virtual environment using

    source venv/bin/activate

Finally run the webserver with

    python3 app/app.py runserver

Make sure to use localhost instead of 127.0.0.1 if you want to be able to login.

## Development

### Changing the database

1. Update models located in 'app/models.py'
2. Run `python app/app.py db migrate` to create a new migration.
3. Apply the changes to the database using `python app/app.py db upgrade`

### Adding dependencies/libraries

1. Add new dependency to the `requirements.in` file
2. Run `pip-compile` to freeze the dependency into the `requirements.txt` file together with its own deps
3. Run `pip-sync` to download frozen deps

### Updating dependencies
Run `pip-compile --upgrade`

For more information about managing the dependencies see [jazzband/pip-tools: A set of tools to keep your pinned Python dependencies fresh.](https://github.com/jazzband/pip-tools)

## Authors

* **Feliciaan De Palmenaer** - *Initial work* - [Github](https://github.com/feliciaan)
find . -type f -exec sed -i s/James/Haldis/g {} \; 2015-04-03 18:41:44 +02:00			`Haldis`
This is really going to hurt 2015-03-31 20:15:22 +02:00			`=======`
vert line is ugly 2019-04-05 02:48:58 +02:00			`[![chat mattermost](https://img.shields.io/badge/chat-mattermost-blue.svg)](https://mattermost.zeus.gent/zeus/channels/haldis)`
Added links, removed unneeded badges Badges for the amount of open issues, PR's and last commit are unneeded, since they are shown in the GitHub UI. I removed them, because they don't always load as fast as the page loads, resulting in ugly text getting displayed. 2019-04-06 11:12:21 +02:00			`[![Website](https://img.shields.io/website/https/haldis.zeus.gent.svg)](https://haldis.zeus.gent)`
			`[![Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade-score/haldis.zeus.gent.svg?publish)](https://observatory.mozilla.org/analyze/haldis.zeus.gent)`
more readable 2019-04-05 02:45:21 +02:00
			`![GitHub commit activity](https://img.shields.io/github/commit-activity/y/zeuswpi/haldis.svg)`
This is really going to hurt 2015-03-31 20:15:22 +02:00
find . -type f -exec sed -i s/James/Haldis/g {} \; 2015-04-03 18:41:44 +02:00			`Haldis is your friendly neighbourhood servant. He exists so lazy fucks like you and me don't need to keep tabs of who is ordering what from where.`
This is really going to hurt 2015-03-31 20:15:22 +02:00			`Start an order and let people add items with a simple mouse-click!`
			`No more calculating prices and making lists!`
			`Be lazier today!`
Added install instructions 2018-03-08 23:23:02 +01:00
update readme with extra docs 2019-04-05 02:04:46 +02:00			`## Local setup`

			`There is a special script to get started with the project. Just run it in the root of the project.`

typo 2019-04-05 02:05:54 +02:00			`./first-setup.sh`
Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00
update readme with extra docs 2019-04-05 02:04:46 +02:00			`This will create a virtual environment, install the necessary dependencies and will give you the option to seed the database.`

Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00			`If you are using a database other then sqlite you will first need to configure the correct URI to the database in the generated 'config.py' file.`
			`Afterwards upgrade the database to the latest version using`
update readme with extra docs 2019-04-05 02:04:46 +02:00
add media querries for side padding 2019-05-31 19:05:40 +02:00			`cd app`
Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00			`python3 app.py db upgrade`

update readme with extra docs 2019-04-05 02:04:46 +02:00			`You can now still seed the database by running`

			`./populate-db.sh`
Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00
update readme with extra docs 2019-04-05 02:04:46 +02:00			`in the root folder of the project.`
add command to run the server/manage deps 2019-04-05 02:12:39 +02:00

			`Activate the virtual environment using`

			`source venv/bin/activate`

			`Finally run the webserver with`

Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00			`python3 app/app.py runserver`

Added a note at the end of the setup section of README to tell the user to use localhost instead of 127.0.0.1 2019-11-20 18:20:11 +01:00			`Make sure to use localhost instead of 127.0.0.1 if you want to be able to login.`

update readme with extra docs 2019-04-05 02:04:46 +02:00			`## Development`

			`### Changing the database`

			`1. Update models located in 'app/models.py'`
Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00			2. Run `python app/app.py db migrate` to create a new migration.
			3. Apply the changes to the database using `python app/app.py db upgrade`
add command to run the server/manage deps 2019-04-05 02:12:52 +02:00
			`### Adding dependencies/libraries`

			1. Add new dependency to the `requirements.in` file
Fix spelling 2019-09-26 22:03:03 +02:00			2. Run `pip-compile` to freeze the dependency into the `requirements.txt` file together with its own deps
update some wording 2019-04-05 02:14:30 +02:00			3. Run `pip-sync` to download frozen deps
add command to run the server/manage deps 2019-04-05 02:12:52 +02:00
			`### Updating dependencies`
			Run `pip-compile --upgrade`

			`For more information about managing the dependencies see [jazzband/pip-tools: A set of tools to keep your pinned Python dependencies fresh.](https://github.com/jazzband/pip-tools)`
satisfy feliciaans authorship requirements 2019-08-29 02:56:34 +02:00
			`## Authors`

Change haldis.py to app.py in README 2019-09-11 22:39:41 +02:00			`* Feliciaan De Palmenaer - Initial work - [Github](https://github.com/feliciaan)`