Giter Club home page Giter Club logo

shadowing_python_demo's Introduction

Newsletter site

Description

This is the beginning of a site for brand that allows users to subscribe to a newsletter.

Installation & Setup

Backend

The backend runs in Docker and uses Poetry to manage dependencies.

Install the following systems before starting

  • Poetry: follow the instructions here
  • Docker if you don't already have it

Now to start the system:

  • poetry install -- install dependencies locally
  • docker compose build -- Build the docker image for the web server
  • docker compose up -- Start the web server

And for development:

  • pre-commit install -- Install the pre-commit hooks
  • poetry shell -- Start the poetry shell

Frontend

The frontend uses TailwindCSS, which watches for changes in Django templates and automatically recompiles the CSS.

To start the CSS watcher:

  • make watch-css

To have the files served by Django, you need to create a symlink to the relevant files from the static folder. Note this setup is in no way production safe, and should be replaced by proper static files serving as per Django's documentation.

  1. cd static
  2. ln -s ../frontend/build.css build.css
  3. ln -s ../frontend/node_modules/flowbite/dist/flowbite.min.js flowbite.js

Other commands

  • See the Makefile for other commands, such as make test to run the tests.

shadowing_python_demo's People

Contributors

mjkilian1992 avatar

Watchers

 avatar

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.