Birdlogger

"Find beauty with wings"

Table of Contents

1. Summary
2. Background
3. Technologies
4. Contributions
5. Reporting Issues
6. License

Summary

Birdlogger is a full-stack mobile-first app that allows users to submit information about bird(s) they observed in public, nature, and just outside their window. Birdlogger is intended for bird-watchers, scientists, bird connoisseurs, and general people who have a fascination with Earth's elegant avians. However, there are very few apps that specifically allow people to record the birds that they observe and access that community-driven information. Therefore, Birdlogger provides a way to submit information about birds by entering characteristics of such birds into a form and receive submitted information from a database displayed on a webpage. Hopefully, Birdlogger will soon be able to promote bird-watching via data entry and visualization which may enable scientific advancements so that we may know every bird in the entire world. 🐦

Background

This project, Birdlogger, was built as my CUNY Tech Prep (CTP) and CISC. 4900 class project. It is my first ever full-stack web-application.

Thank you to Instructor Edgardo Molina and Jonathan Chery for supervising this project! 😃

Technologies

Front-End

• Qwik.js
• Qwik City
• Tailwind CSS
• TypeScript
• Vite

Back-End

• Elysia.js
• Prisma ORM
• PostgreSQL
• Supabase
• Bruno
• TypeScript

JavaScript runtime & toolkit

• Bun.js
• Node.js

Contributions

Contributions to Birdlogger shall be accepted after Wednesday, May 30^th, 2024 because of deadlines to submit and display this project from CTP and CISC. 4900. Contributing to Birdlogger is welcomed and appreciated. Please open a pull request and a description of what you would like to submit.

Notices and Precautions

Please make sure to install bun.js and follow documentation for each technology. Add your .env files to your local repository because the .gitignore files prevent .env files from being pushed to Birdlogger's GitHub Repository. Turn off your VPN when entering commands for Prisma ORM, bun start, and bun dev or else you may get errors. Install Prisma ORM with Node.js. Installing Prisma ORM with Bun.js may give you errors and difficulties.

Known Issues

• Patch request functions from /backend's /routes/handler.ts and /routes/index.ts do not update Bird data information and may throw errors.
• Missing .env files error message that may occasionally appear when inspecting Qwik.js webpages after entering the command bun dev or bun start.

Reporting Issues

If you have any questions, have found a bug or vunerability, or would like to suggest any improvements please submit them under Birdlogger's GitHub repository Issues tab.

License

MIT License

©️ 2024 All Rights Reserved