• Overview
  • Purpose
  • Team
• Getting Started for Developers
  • Clone the repository
  • Run the frontend
  • Run the backend
  • Making changes
  • Other onboarding info

The purpose of this application is to ... for the nonprofit (nonprofit name) ...

The (Project Name) team consists of ... Cal Poly students. Over the course of about 9 months, we worked as a team to deploy this web application. The team members are listed below:

(From left to right)

• PM Name - Project Manager
• Designer Name - Designer
• Tech Lead Name - Tech Lead
• Dev 1 Name - Software Developer
• Dev 2 Name - Software Developer
• Dev 3 Name - Software Developer
• Dev 4 Name - Software Developer
• Dev 5 Name - Software Developer

Note: This is just an example, this section on your Readme will likely look different than this, dependent on your project

insert your repository link here

1. first step for setting up and running frontend
2. second step for setting up and running frontend, ...

1. first step for setting up and running backend
2. second step for setting up and running backend, ...

1. Describe the process this team follows for making changes(i.e. Create a new branch -> commit change to branch -> create a PR -> ...

Provide additional non-sensitive information that an incoming developer would need to start making changes. Do NOT put any passwords or api keys in the Readme