Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 3.38 KB

README.md

File metadata and controls

75 lines (50 loc) · 3.38 KB
Raw

Getting Started

In the root directory of the project...

  1. Install node modules yarn install or npm install.
  2. Install Python dependencies yarn install-requirements or npm install-requirements
  3. Start development server yarn start or npm start.

Next Steps

Adding a New Page

  1. Create a folder in /src/components with your react components.
  2. Add a route for your page to /src/App.js.
  3. Add a button to the navigation bar in /src/components/NavBar/index.js.

Deployment

If you selected Azure App Service when creating your project, follow these steps:

  1. Press Ctrl + Shift + P in Windows/Linux or Shift ⇧ + Command ⌘ + P in Mac and type/select Web Template Studio: Deploy App to start deploying your app.
  2. After your project is built, click on "server" in the pop up on the top middle section of your screen, and then click "Deploy" on the window pop up.
  3. Once the deployment is done, click "Browse website" in the notification window on the lower right corner to check out your newly deployed app.

If you did not select Azure App Service and want to create a new Azure App Service web app, follow these steps:

  1. Press Ctrl + Shift + P in Windows/Linux or Shift ⇧ + Command ⌘ + P in Mac and type/select Azure App Service: Create New Web App... to create a new web app.
    • Select your subscription
    • Enter your web app name
    • Select Linux as your OS
    • Select Node.js 10.14 for a Node/Express application, Python 3.7 for a Flask application
  2. Once the creation is done, click "Deploy" in the notification window on the lower right corner.
    • Click "Browse" on the top middle section of your screen and select the server folder within your project
    • Click "Yes" in the notification window on the lower right corner (build prompt)
    • Click "Deploy" on the window pop up
    • Click "Yes" in the notification window on the lower right corner again
  3. Once the deployment is done, click "Browse website" in the notification window on the lower right corner to check out your newly deployed app.

Consider adding authentication and securing back-end API's by following Azure App Service Security.

Full documentation for deployment to Azure App Service can be found here: Deployment Docs.

File Structure

The front-end is based on create-react-app.

The back-end is based on Flask.

The front-end is served on http://localhost:3000/ and the back-end on http://localhost:3001/.

.
├── server/ - Flask server that provides API routes and serves front-end
│ ├── constants.py - Defines the constants for the endpoints and port
│ └── server.py - Configures Port and HTTP Server and provides API routes
├── src - React front-end
│ ├── components - React components for each page
│ ├── App.jsx - React routing
│ └── index.jsx - React root component
└── README.md

Additional Documentation