Skip to content

Latest commit

ย 

History

History
48 lines (27 loc) ยท 2.08 KB

README.md

File metadata and controls

48 lines (27 loc) ยท 2.08 KB

๐—ง๐—ถ๐—ด๐—ฒ๐—ฟ๐—ฆ๐˜๐˜‚๐—ฑ๐˜†๐Ÿฎ

This project is the 2nd version of TigerStudy, a web application that helps Princeton students find study groups for their classes. This version is a complete rewrite of the original project with a new design and features.

Getting Started

First, make sure you have Node.js installed on your machine. You can download it here.

To install the project dependencies, run npm install.

To run the project, run npm dev. To format the code, run npm format. To lint the code, run npm lint.

To access DrizzleKit Studio to get a nice UI for the relational database, run npm db:studio. You can visualize the schema by running npm db:schema and then viewing the dbml file that is generated through the recommended extension.

Technologies

Frontend:

Backend:

Dev Tools:

Contributing

If you would like to contribute to this project, please message the TigerApps board on Discord (if you are a TigerApps member) or via email at [email protected].

Please make sure to add file comments that specify authorship. Also, make sure to run npm format and npm lint before committing your changes.

Acknowledgments

This version of TigerStudy was made by Joshua Lau '26 with support from the McGraw Center and TigerApps.

The original TigerStudy project was made by Caroline di Vittorio '22 and Kasey McFadden '22 with implementation support by Shannon Heh '23 and Nick Padmanabhan '23.

License

This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.