An open API service indexing awesome lists of open source software.

https://github.com/aspects19/hitimu

A community managed website to make access to study material easier
https://github.com/aspects19/hitimu

appwrite collaborate react students study typescript

Last synced: about 1 month ago
JSON representation

A community managed website to make access to study material easier

Awesome Lists containing this project

README

          

# Hitimu | A hackathon project
https://hitimu.vercel.com
### Introduction
Access to study material by students is a major barrier faced by students. Platforms that offer this service eg **Studocu** often have paywalls and strict upload policies preventing easy access to study material.
**Hitimu** is a platform for students that simplifies sharing of study material. Students can upload, view, download, and comment on documents like notes, past papers, essays, and much more.

![TypeScript](https://img.shields.io/badge/TypeScript-v5.7.2-blue?style=flat&logo=typescript&logoColor=white)
![Appwrite](https://img.shields.io/badge/Appwrite-v17.0.2-pink?style=flat&logo=appwrite&logoColor=white)
![Vite](https://img.shields.io/badge/Vite-v6.3.1-purple?style=flat&logo=vite&logoColor=white)
![TanStack Router](https://img.shields.io/badge/TanStack%20Router-v1.117.0-orange?style=flat&logo=react-router&logoColor=white)
![DaisyUI](https://img.shields.io/badge/DaisyUI-v5.0.28-green?style=flat&logo=tailwindcss&logoColor=white)
![React](https://img.shields.io/badge/React-v19.0.0-blue?style=flat&logo=react&logoColor=white)

## Features
- **Upload and Share**: Students can upload study materials like notes, past papers, and essays.
- **Search Functionality**: Quickly find study materials using keywords.
- **User Profiles**: View and manage your uploaded documents.
- **Secure Authentication**: Login and signup using email/password or third-party providers like GitHub and Google.
- **Responsive Design**: Fully responsive UI built with TailwindCSS and DaisyUI.
- **Open Source**: Community-driven and open for contributions.

## Installation
To set up the project locally, follow these steps:

1. Clone the repository:
```sh
git clone https://github.com/aspects19/hitimu.git
cd hitimu
```
2. Register for your own **Appwrite** credentials and replace them in ` src/lib/appwrite.ts `

3. Install project dependencies
```sh
yarn install
```
4. Run your app
```sh
yarn dev
```

## Contributions
If You wish to make contributions to this project such as reporting issues and bugs, fixing them and adding features, take a look at [contribution guide](https://github.com/aspects19/hitimu/blob/main/CONTRIBUTING.md)

## License

This project is licensed under the MIT License – see the [LICENSE](https://github.com/aspects19/weather-app/blob/main/LICENSE) file for details.

##