Skip to content

jalbe0076/starry-nights

Repository files navigation

STARRY NIGHTS

A celestial event calendar

Built With:

DEPLOYED LINK

Abstract:

This is a website that informs users of upcoming celestial events by fetching data from the NASA API. The MVP for this project required users to browse upcoming events and save them to and delete from a list. Additional stretch features such as improving the UI by displaying the events on a calendar instead of the list and allowing users to add personal notes for events which were viewed could be some of the next features implemented into this app.

Preview of App:

Desktop preview:

Demo of app on a desktop


Mobile preview:

Demo of app on a cell phone


Bad URL & Routing:

Demo of app sad paths on a desktop

Installation Instructions

  • Please apply for an API key from NASA to run the app locally and view/run tests. Save this key in a .env file located in your root directory. Save your key to the following variable REACT_APP_API_KEY = "YOUR_KEY_GOES_HERE".
  • Fork this repository.
  • Clone it to your local machine using the command: git clone [email protected]:jalbe0076/starry-nights.git.
  • Run the command: cd sarry-nights
  • Run the command: npm install
  • Run the command: npm start
  • Once the modules have finished compiling, enter http://localhost:3000/ into your browser to see the live web page.
  • Run npm run cypress to run tests, the website must be running for tests to pass.

Context:

  • Mod 3, Week 5:

    • I am a current student of Turing School of Software & Design.
    • Turing is a 7 month program, which offers a total of 4 modules.
    • This project was completed during the third module that the program has to offer.
    • Students are required to work under a tight time constraint to deliver an apporved MVP.
  • A total of approximately 35 hours was spent on this project.

Contributors:

Learning Goals:

  • Practice creating personas and user stories
  • Create a responsive user interface that is easy to use and clearly displays information
  • Write DRY, reusable code that follows SRP and trends toward function purity
  • Make network requests (using fetch API)
  • Further improve React fundamentals
  • Test React components & asynchronous JS
  • Practice refactoring
  • Create a multi-page UX using Router

About

Turing Mod 3 showcase project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published