Skip to content
This repository has been archived by the owner on Jun 2, 2023. It is now read-only.

jackheywood/mars-app-winterns-2019

 
 

Repository files navigation

Mars App

This is the starting template for a Corndel training project to create a React Web Application which will display recent data from Mars obtained by NASA using NASA's Open APIs.

Prerequisites

Setup

  1. cd to the root directory of this repository.
  2. Run npm install.
  3. Open the project in VSCode.
  4. Install the recommended extensions.
    • You can see these by running "F1 -> Show Recommended Extensions" in VSCode.

Workflow

We'll be keeping track of the project tasks using Trello.

  • Sign up for a Trello account.
  • Ask your trainer to add you to the Mars App Board.

The workflow should be as follows:

  1. Assign yourself to a ticket from the "To Do" column in discussion with your trainer and move it to "In Progress".
  2. Pull the latest version of master.
  3. Create a new branch with name of the form ${ticketNumber}_ShortDescription
    • e.g. MARS-2_CreateRoverComponent
  4. Write some code!
  5. Push to a remote branch on GitHub.
  6. Create a GitHub pull request for your ticket and request a pull request review from your trainer.
  7. Move the ticket to "In Review" in Trello.
  8. Once your trainer has reviewed your code:
    • If there any changes needed, carry them out and push to GitHub again.
    • Repeat until both you and the reviewer are satisfied with the code.
  9. Once your branch has been completely signed off, merge it into master and push.
  10. Move the ticket to "Completed" and repeat!

Available Scripts

In the project directory, you can run:

npm start

Runs the Mars 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!

Deployment

We're hosting our app using Firebase Hosting.

To get set up with Firebase:

  1. Sign into the Firebase Console and let your trainer know the email address you use to log in.
  2. Install the Firebase CLI globally by running npm install -g firebase-tools.

Deployment steps

Remember to confirm with your trainer before deploying anything to Firebase

  1. Build the project by running npm run build.
  2. Deploy to Firebase by running firebase deploy.

Learn More

This project was bootstrapped with Create React App.

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 80.5%
  • CSS 16.2%
  • HTML 3.3%