Skip to content

rupertpople/seedle

Repository files navigation

Coral Baker | Rupert Pople | Monica Navarro | David Ewan Campbell

Website Requirements

Seedle is an online local species explorer and our first 2 weeks of learning how to use React. This program allows users to:

  • Input their postcode or select a 'your location' button.
  • Receive plant and birds names.
  • See images of these plants and birds.
  • Read descriptions of these results.
  • Click on a button to allow them to read into these further.
  • Go back to the top of the page once they have scrolled further down.

Seedle Demo

Team Charter

What we expect from eachother
Support, patience, trust, openess, a positive environment, communication & to feel comfortable sharing issues.

Agile Structure
Regular stand ups, retros & lunch-time check-ins, 2 day sprints and pair programming.

Time Commitment
9:45 to 6 with 1 hour lunch breaks 1 to 2. Evenings optional.

Tracking and Progress
Use a Trello board, slack for constant communication.

Must-Haves

  • Personal objectives
  • Team objectives
  • Time commitment / breaks
  • Knowledge sharing

User Stories

MVP:

As a user,
So that I can look up local species names,
I want to enter my postcode and view the results.

Additional Stories:

As a user,
So that I don't have to look up local species by postcode,
I want to have an option to select 'my location'.

As a user,
So that I can identify these species,
I want to view images of each result.

As a user,
So that I can find out facts about local species,
I want to read a description of each result.

As a user,
So that I can read further into these details,
I want an option to be directed to more information.

As a user,
So that I can see local activity,
I want to see the sightings in my area.

Tech Stack

  • React for building the user interface.
  • Node.js for runtime JavaScript.
  • Express web framework for Node.js.
  • Nodemon to reload the server automatically.
  • Jest for testing.
  • Cypress for end-to-end testing.
  • ESLint for linting.
  • Heroku for hosting for deployment.
  • Trello for agile team working development.
  • Excalidraw for domain modelling.
  • Slack for planning, pair-programming, info-sharing & regular check-ins.
  • Github and Git for version control.

Website Layout and Ideas

We used excalidraw to plan out ideas on how the website might look:

We used Trello to plan out our tickets for deploying each feature, moving them along as they were implemented & completed:

Installation

  • Fork from one of our repositories https://github.com/rupertpople/seedle.git for example.
  • Clone your new forked repository using git clone followed by your fork URL.
  • Move into the repository by using cd seedle.

Available Scripts

This project was bootstrapped with Create React App. In the project directory, you can run:

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!

See the section about deployment for more information.

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may 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.

Learn More

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

Contributors 4

  •  
  •  
  •  
  •