Giter VIP home page Giter VIP logo

flask-react-starter's Introduction

Bootstraped w/ React and Flask

This project was bootstrapped with Create React App. This project's backend was bootstrapped with Flask.

Full Tech Stack

Frontend: TypeScript React Bootstrap Axios

Backend: Python Flask SQLAlchemy Werkzeug

Getting Started with Create React App

In the project directory, you can run the following commands after installation:

See the README.md of the backend section regarding the flask application that serves as the data and control center of the frontend application.

Using default react README.md until documentation is written.

Available Scripts

npm install

This will install the required frontend dependencies.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

learn more in the Create React App documentation.

To learn React, check out the React documentation.

Getting Started with the Flask Backend

In the backend/ directory, you can run the application after doing a basic setup.

Setup

pip install -r requrements.txt

Installs all the backend dependencies required to run the server application.

flask run

Will start the server application.

Database Setup (optional)

Preloaded (default)

The project repository includes a backend database preloaded with the data required to allow a full demo of the application.

Reset

If you wish to reset the database and start with no data then it is necessary to do the following from the backend/ direcotry:

rm -rf migrations && default.db

Will remove the migrations folder and the sqlite database which is generated by flask-sqlalchemy

flask db init

Will create the new database.

flask db migrate

Allow flask-sqlalchemy to make changes to the database using the database models in the application.

flask db upgrade

Commit these changes to the database.

flask-react-starter's People

Contributors

crispycret 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.