https://github.com/deneutoy/webapp-template

https://github.com/deneutoy/webapp-template

Last synced: 17 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/deneutoy/webapp-template
• Owner: DeNeutoy
• License: apache-2.0
• Created: 2021-02-14T01:16:40.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-07T05:28:07.000Z (almost 2 years ago)
• Last Synced: 2024-10-26T23:42:53.618Z (about 2 months ago)
• Language: Python
• Size: 3.11 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### Python Development

The Python service and Python cli are formatted using `black` and `flake8`. Currently this is run in a local environment

using the app's `requirements.txt`. To run the linters:

```

black api/

flake8 api/

```

## Prerequisites

Make sure that you have the latest version of [Docker 🐳](https://www.docker.com/get-started)

installed on your local machine.

To start a version of the application locally for development purposes, run

this command:

```

~ docker-compose up --build

```

This process launches 3 services, the `ui`, `api` and a `proxy` responsible

for forwarding traffic to the appropriate services. You'll see output

from each.

It might take a minute or two for the application to start, particularly

if it's the first time you've executed this command. Be patience and wait

for a clear message indicating that all of the required services have

started up.

As you make changes the running application will be automatically updated.

Simply refresh your browser to see them.

Sometimes one portion of your application will crash due to errors in the code.

When this occurs resolve the related issue and re-run `docker-compose up --build`

to start things back up.