https://github.com/tigerappsorg/tiger-study-2

🌿•₊✧💻⋆⭒˚☕️｡⋆ Find study groups at Princeton!
https://github.com/tigerappsorg/tiger-study-2

bun shadcn-ui sqlite svelte

Last synced: about 2 months ago
JSON representation

🌿•₊✧💻⋆⭒˚☕️｡⋆ Find study groups at Princeton!

• Host: GitHub
• URL: https://github.com/tigerappsorg/tiger-study-2
• Owner: TigerAppsOrg
• License: mit
• Created: 2024-10-03T23:35:12.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-11-22T21:17:08.000Z (2 months ago)
• Last Synced: 2024-11-22T21:29:23.977Z (2 months ago)
• Topics: bun, shadcn-ui, sqlite, svelte
• Language: Svelte
• Homepage: https://study.tigerapps.org
• Size: 911 KB
• 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

This project uses [pnpm](https://bun.sh/). To install pnpm, run `npm install -g pnpm`.

To install the project dependencies, run `pnpm install`.

To run the project, run `pnpm dev`. To format the code, run `pnpm format`. To lint the code, run `pnpm lint`.

To access DrizzleKit Studio to get a nice UI for the SQLite database, run `pnpm db:studio`. You can visualize the schema by running `pnpm 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/)

-   [SQLite](https://www.sqlite.org/index.html)

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 [[email protected]](mailto:[email protected]).

Please make sure to add file comments that specify authorship. Also, make sure to run `pnpm format` and `pnpm 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.