GithubHelp home page GithubHelp logo

jferragut / flask-microservices-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
6.0 3.0 3.0 106 KB

A simple framework for building Flask Microservices.

Home Page: https://flask-microservices-boilerplate.jferragut.now.sh

Python 63.04% Shell 36.96%
open-source flask-microservices flask zeit-now-integration heroku-deployment python3 looking-for-contributors hacktoberfest2019 hacktoberfest

flask-microservices-boilerplate's People

Contributors

allcontributors[bot] avatar jferragut avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

flask-microservices-boilerplate's Issues

Bug: Database issue with Zeit

Bug: Zeit doesn't appear to support MySQL databases or any for the time being. (which breaks the example)

Screen Shot 2019-08-25 at 1 49 36 AM

Request: Need to set up a firebase example so that there is some sort of queryable version of an endpoint.

there should be no initial migration folder

Working with and Submitting Issues

Existing Issues

When working with existing issues, you will need to keep a clear line of comments detailing what you are working on and how you plan to address the current issue.

If you are doing a PR or any commits, please make sure to reference the issue number in the respective commit or PR.

New Issues

When submitting a new issue, your headline should contain the following:

Issue Type: Issue Title

Example titles:

BUG: Routes don't work with Heroku

FEATURE: Add Heroku install script

For the issue body, your template will vary.

BUGS

Please use the following template:

### Prerequisites

* [ ] Can you reproduce the problem in safe mode?
* [ ] Are you running the latest version?
* [ ] Did you check the debugging guide?
* [ ] Did you check the FAQs on Discuss?
* [ ] Are you reporting to the correct repository?
* [ ] Did you perform a cursory search?

For more information, see the `CONTRIBUTING` guide.

### Description

[Description of the bug or feature]

### Steps to Reproduce

1. [First Step]
2. [Second Step]
3. [and so on...]

**Expected behavior:** [What you expected to happen]

**Actual behavior:** [What actually happened]

### Versions

You can get this information from executing `npm version`.

Pull Requests

Please use the following template:

## Types of changes

What types of changes does your code introduce? Put an `x` in all the boxes that apply:

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] I have read the **CONTRIBUTING** document.
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.

## Comments
Please add any comments here.

Roadmap

This issue represents the tasks that we would like accomplished for the project at the current time. If we are taking control of a task, or adding one here, there should be an associated issue card to track what is being done.

  • Update documentation for each of the functionalities #4
  • Update bash install script for conditional logic. (Must ask if user wants a specific installer set up and respond to user input.)
  • Setup boilerplate to deploy on Heroku via script #3
  • Setup boilerplate to work with Netlify
  • Configure Database example to work with Google Firebase database storage #2
  • Configure Database example to work with AWS database storage

Docs: Add section on dynamic routes config

  • Explain use of now.json (with link to zeit now docs)
  • Explain folder structure (every service that should be an active route needs an index.py that will handle the view (don't use named files unless you are building static routes)

Feature: Heroku config and deployment

Need to prepare and test integration with heroku.

  • add dependencies to install script
  • add package to pipenv
  • create heroku demo account
  • add config
  • test integration

Dynamic routing on Zeit Now

Dynamic routing is not working when routes are not in repo root.
Tracking issue here: vercel/vercel#2685

Right now, You can declare all routes manually. The objective for this framework, however, should be to establish dynamic routes.

We should continue to track the issue listed above and update after the fix releases.

Docs: Create Contribution Guide and Issue Template

So that the repo can truly be open source, we need a contribution guide and templates for PR and Bug reports.

  • Create Contribution Guide
  • Integrate bot for Contributors
  • Add Issue template and PR Template
  • Update readme to reference contribution guide

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.