Restro

Your one-stop solution for all you restaurant management.

Project Setup

1. Clone the repository
2. Create .env file:

   cp .env.example .env

   NOTE: Please make sure that DATABASE_NAME is set as 'druling' when running django app locally.
3. Install the required dependencies:

   pip install -r requirements.txt

4. Run migrations:

   python manage.py migrate

5. Run the development server:

   python manage.py runserver

6. Run test cases

   python manage.py test

Before commit

1. Run this command

   pre-commit install

2. Enable Auto-Save:
   • Go to Preferences > Appearance & Behavior > System Settings.
   • Enable "Save files automatically if application is idle".

This will save files automatically when you're not typing, triggering the File Watchers if configured.

Useful commands

Adding package in requirement txt

pip freeze > requirements.txt

Creating migrations

 python manage.py makemigrations

Run within Docker containers

Build docker images

NOTE: Just make sure your requirements.txt and .env file is up-to-date.

• This will build all the services together

  docker compose build
  

• This will build/re-build single service at a time

  docker compose --build web
  

• Running the containers

   docker compose up -d
  

• Stop the containers

   docker compose stop
  

• Stop and delete the containers along with their networks and temporary volumes.

   docker compose down
  

Using S3 on localstack

We use localstack for AWS S3 while testing it is part of docker compose file.

• GUI here https://docs.localstack.cloud/user-guide/tools/localstack-desktop/

Setup mail templates

To setup mail templates, you need to run the following command:

python manage.py setup_email_templates