Code Monkey home page Code Monkey logo

samuel's Introduction

Samuel

From Google Sheets and punch cards to a single-click order! This project was made to streamline the process of managing and scheduling dishes by our company chef, as well as placing orders by the employees.

Overview

Instead of each morning sending the dishes available for today to the reception desk and them sending an email to the employees, now the chef could easily do it by himself! Just fill the form for a new dish, choose a date, and click a button to send an email.

After scheduling some dishes and distributing them by email, the users could order them in a simple UI. When the dishes are ready, the chef would let the users know with a click of a button.

Instead of getting a 10-hole punch card and punching it for every order you make, now nothing needs to be done! The accounting department could charge employees by exporting their orders directly from the admin panel.

Environment Variables

Before developing/deploying, don't forget to set environment variables by:

cp .env.example .env

and modify the values.

Development

Prerequisites

Back-end

Front-end

Dependencies

Back-end

cd backend
PIPENV_VENV_IN_PROJECT=true pipenv install -d

PIPENV_VENV_IN_PROJECT documentation.

Front-end

cd frontend
yarn install

Usage

Back-end

VS Code

There's a VS Code launch configuration called Python: Django, so just hitting F5 should work for both running and debugging.

Docker
cd backend
docker-compose -f docker-compose.dev.yml up

Front-end

cd frontend
yarn start

Test

Back-end

VS Code

Just as the Python: Django configuration, there the Python: Django Test launch configuration that allows to run and debug tests.

Docker

cd backend
docker-compose -f docker-compose.test.yml up --exit-code-from tests

Front-end

cd frontend
yarn test --runInBand

Deploy

Download Required Files

curl --remote-name-all https://raw.githubusercontent.com/eyalch/samuel/production/{docker-compose.yml,.env.example}

Don't forget to configure environment variables in .env.

Run

After the CI/CD pipeline has finished successfully, run the following in the same directory where you've downloaded the required files:

docker-compose pull
docker-compose up -d

Technologies

Back-end

Front-end

Authentication

  • LDAP/Active Directory
  • JWT

Error Tracking

samuel's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.