Skip to content

zstrings/web-design-challengedb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

serenity-logo

DP2 Serenity Front-End

license

Table of Contents

  1. Basic Commands
  2. Deploy the app
  3. Commit Convention
  4. Deploy toAWS S3 bucket

Basic Commands

Install dependencies Scripts

In the project directory, you can run:

    npm install

Run in development mode

In the project directory, you can run:

    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.

Run tests

    npm test

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

Deploy the app

Build production app

    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!

Commit Convention

In order to make it easy to review the previous commits and understand the "what"s and "why"s behind each change, the following commit pattern is used:

  • To make descriptive commits the command git commit -v is used.
  • Otherwhise, git commit -m "<message>" command can be used when the commit message is not long enought to give it a body.
<type>: <subject>
<BLANK_LINE>
<body> (optional)

The definition for each commit section is as follows:

<type>: A short label of the type of change.

  • It can be any of the following:
    • FEAT: A new feature
    • FIX: Bug fix
    • DOCS: Documentation changes
    • STYLE: Formatting, missing spaces, etc
    • REFACTOR: Code that it's neither a feat nor a fix

<subject>: It is a short description of the commit

  • In general, no more than 80 characters
  • Written in present tense
  • Starts with capital letter

<body>: The long description of the commit

  • Explains why the commit is needed
  • Briefly explains what the commit does
  • Talks about the related test cases and docs
  • In general, no more than 80 characters per line

Deploy to AWS S3 bucket:

  • Deploys the app to an aws S3 bucket.
  1. Follow all the next steps.

  2. Make the build folder, wich will contain all required files for our app.

npm run build

img

  1. After the execution of that command, you will be able to see a new folder: "./build".
  2. Log in into your aws account and create an S3 bucket with all read permissions enabled.
  3. In the created bucket, in the "properties" option switch to "enable" the option to host static web sites.

img

img

  1. Drag'n drop all the content of the "build" folder and drag them into the S3 bucket panel to start loading them.

img

img

  1. Select all files to load.
  2. Allow public read to everybody.

img

img

  1. Once all the files have been loaded correctly, in your browser go to the corresponding URL to check the app runnig.
  • The deployed app can be accesed in its URL that follows this pattern: http://"bucket_name".s3-website-us-east-1.amazonaws.com/.

About

Statistical and econometric projects for understanding human behaviour

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published