Skip to content

bcgov/Capstone-2026

Repository files navigation

🚀 capstone-2026

Contributors Forks Stargazers Issues project_license LinkedIn


alt text

Capstone-2026

A feedback modal that is able to return meaningful results from aggregating data of BC Gov website users experiences.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Capstone 2026 project is a feedback modal that is resuable enough to be incorporated into many BC Government pages to recieve user feedback after completing a transaction. Our stretch goal included adding a dashboard feature for seeing compiled and meaningful data.

(back to top)

Built With

  • React
  • TypeScript
  • Vite
  • NestJS
  • PostgreSQL
  • PostGIS
  • Docker
  • Caddy

(back to top)

Getting Started

In the root folder copy .env.template and rename .env then add the database password to var DATABASE_URL.

Run docker compose up and Compose will start and run your entire app.

Docker compose up

In the backend folder, migrate the schema to be up to date with database

npx prisma migrate reset 
for windows use - npx.cmd prisma migrate reset

### Prerequisites

How to install what you need 
* npm
  ```sh
  npm install npm@latest -g

Installation

  1. Clone the repo

    git clone https://github.com/bcgov/Capstone-2026.git
  2. Create a .env file in the project root:

    DATABASE_URL=postgresql://postgres:default@database:5432/postgres
  3. Start Docker Desktop.

  4. Build and start the containers

    docker compose up --build
  5. Access the application:

    Frontend: http://localhost:5173
    Backend API: http://localhost:3000

(back to top)

Usage

This project is intended to be an interactable modal that pops up when user completes a transaction on a BC gov website. The user should be able to engage or decline with the pop up

alt text

When the feedback form opens the user is met with a variety of questions that are pulled from the database. Our project was built to be reusable and as such admins may change questions from our dashboard interface

alt text

Once user fills in the form they are free to submit or cancel

alt text

And a message should inform the user if their action was successful or not as well as give them an ID attatched to their form!

alt text

**Add dashboard interface when completed

_For more examples, please refer to the Documentation

(back to top)

Roadmap

  • A button that opens a modal asking user to engage in feedback
  • A feedback form that opens and pulls questions from the database
  • A confirmation or error message depending on the success or failure of the feedback.
  • [] A dashboard for admin or product owners to modify questions or view aggregated data.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the project_license. See LICENSE.txt for more information.

(back to top)

Contact

Ebba de Groot - degrootebba@gmail.com

Tey Cheng - pagnavathtey@gmail.com - (LinkedIn) https://www.linkedin.com/in/pagnavathtey-cheng-2858452b0

Maia Grisch - maiagrisch@outlook.com

Project Link: https://github.com/bcgov/Capstone-2026

(back to top)

Acknowledgments

(back to top)

About

For use by the 2026 Camosun Capstone team

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors