Code Monkey home page Code Monkey logo

maze's Introduction

Test

Development

Clone this repository.

Create a virtual environment, for example, directory venv using Python's venv module.

python -m venv venv

Activate the new environment with:

source ./venv/bin/activate

Make sure the latest pip version is in your virtual environment:

pip install --upgrade pip

Install all dependencies:

pip install -r requirements.txt

Test run cli tool to generate a cat shaped maze:

maze

Usage (TBD)

maze's People

Contributors

serixscorpio avatar dependabot[bot] avatar

Watchers

 avatar  avatar

maze's Issues

Deploy to production

Problem

Decide on a deployment strategy. Options:

  1. poetry, dockerize, PaaS (DigitalOcean Apps Platform)
  2. DigitalOcean Functions (see https://www.digitalocean.com/community/conceptual_articles/how-to-write-a-serverless-function). This approach does not seem compatible with using FastAPI.
  3. poetry, non-dockerize, IaaS (digital ocean). Choose this for simplicity. (without docker, the deployment seems fragile)
  4. poetry, heroku (not sure if this will work)
  5. deta (can't specify poetry as run command, might need to turn the maze portion into a package that the fastapi app depends on)

Then, execute this deployment strategy.

Acceptance Criteria

  • Maze can be deployed to production following some repeatable steps.
  • The repeatable steps are documented.

Solution Approach

Use DigitalOcean's App Platform given we already have a working Dockerfile. App Platform is optimized for ease of code deployment rather than deep customization of the underlying infrastructure. This approach relies on DO to analyze and build code from Github (the current chosen source control repo), and sidestep various DevOps complexities. If we want more control to customize deployment, we can revisit. For now, this seems like a good way to deploy to production.

Steps to deploy to production

  1. Do a local build from Dockerfile. More details to follow.
  2. Use DO's 'App Spec' to define the repo/branch to pull the code from to do the docker build. (For now, choose github and main branch)
  3. In DO's UI, kick off a deploy (in case there is no changes to the source control) Rely on Apps Platform for TLS connection, and other security features.

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.