🕹️Stardew Friends🎮

⬆ Click the header to visit the site ⬆

There are so many friends to be made and so many details to recall! This app helps Stardew Valley players quickly reference details about friendable NPCs and track friendships with them.

Preview

Technologies Used

Installation Instructions

Note

The front-end and back-end are both deployed, so installation is not needed to use the web app. FE installation is required for running tests.

FE Installation Instructions:

• Run the following on command line to clone the repo and run the app locally:

  git clone [email protected]:tednaphil/stardew-friends.git
  cd stardew-friends
  npm install
  npm start
  

BE Installation Instructions:

• Link to BE repo
• Deployed API link https://ruby-stardew-api.onrender.com
• Run the following on the command line to clone the repo and navigate into the project directory

  git clone https://github.com/tednaphil/ruby-stardew-api.git
  cd ruby-stardew-api
  

• Install gems

  bundle install
  

• Setup the database

  rails db:{drop,create,migrate}
  

• Start the server locally - server will run at http://localhost:3000

  rails server
  

• To stop the server, use Ctrl + C in the open terminal

Run Tests:

• Ensure you're running the app locally (see FE Installation Instructions above)
• Run the following on command line to open Cypress: npm run cypress
• Click E2E Testing, then Start E2E Testing in desired browser
• Select App_spec to run user story tests
• Select Error_spec to run error handling tests

Context

• ~ 20 hours spent on BE, FE, and testing collectively during a 1 week sprint

• App built during second week of self-teaching Typescript

• Goals

  - Thorough testing of user-stories with intercepted network requests
  - Responsive design across mobile, tablet, and desktop devices
  

• Wins

  - Automatic deployments for UI (Vercel) and API (Render)
  - Addition of two features beyond the MVP (search and frienship level incrementer)
  

• Challenges

  - Making first Express app a consumable API - researching CORS allowed for succesful use!
  - Increased loading time after API spins down due to inactivity
  

• Next Steps

  - User Login
  - Informational component explaining Stardew Valley Friendship building
  

  Wireframe: