https://github.com/tigerappsorg/tiger-study-2
๐ฟโขโโง๐ปโโญหโ๏ธ๏ฝกโ Find study groups at Princeton!
https://github.com/tigerappsorg/tiger-study-2
postgresql shadcn-ui svelte
Last synced: 4 months ago
JSON representation
๐ฟโขโโง๐ปโโญหโ๏ธ๏ฝกโ Find study groups at Princeton!
- Host: GitHub
- URL: https://github.com/tigerappsorg/tiger-study-2
- Owner: TigerAppsOrg
- License: bsd-3-clause
- Created: 2024-10-03T23:35:12.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-21T00:39:37.000Z (over 1 year ago)
- Last Synced: 2025-03-26T11:01:45.269Z (over 1 year ago)
- Topics: postgresql, shadcn-ui, svelte
- Language: Svelte
- Homepage: https://study.tigerapps.org
- Size: 1.12 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ๐ง๐ถ๐ด๐ฒ๐ฟ๐ฆ๐๐๐ฑ๐๐ฎ
This project is the 2nd version of [TigerStudy](https://study.tigerapps.org), 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](https://nodejs.org/en/).
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:
- [Svelte](https://svelte.dev/)
- [Tailwind CSS](https://tailwindcss.com/)
- [ShadCN Svelte](https://www.shadcn-svelte.com/)
Backend:
- [NodeJS](https://nodejs.org/en/)
- [SvelteKit](https://kit.svelte.dev/)
- [PostgreSQL](https://www.postgresql.org/)
Dev Tools:
- [Prettier](https://prettier.io/)
- [ESLint](https://eslint.org/)
## 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 [it.admin@tigerapps.org](mailto:it.admin@tigerapps.org).
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](https://github.com/joshuamotoaki) with support from the [McGraw Center](https://mcgraw.princeton.edu/) and [TigerApps](https://tigerapps.org/).
The original [TigerStudy](https://github.com/TigerAppsOrg/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](LICENSE) file for details.