https://github.com/brileighk/resource-library

Headstarter Hackathon Project - Community-driven resource library
https://github.com/brileighk/resource-library

Last synced: about 4 hours ago
JSON representation

Headstarter Hackathon Project - Community-driven resource library

• Host: GitHub
• URL: https://github.com/brileighk/resource-library
• Owner: BriLeighk
• Created: 2024-07-27T04:25:26.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-07-27T12:09:49.000Z (4 months ago)
• Last Synced: 2024-07-28T07:36:58.848Z (4 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Resource Library

Headstarter Hackathon Project: Community-driven library of resources with search & filter features,

with API integration for authentication of user-uploaded resources.

## Project Setup:

### Project Structure:

- **Setup:** git clone repository in local environment

- **Install dependencies:** pip install -r backend/requirements.txt

### MongoDB:

- **Accept invite** from MongoDB Atlas project

- **Create User:** Database Access->Add New Database User->create username/password + set built-in role to Atlas Admin.

- **Connect to Database:** All Clusters->ResourceLibraryCluster->Connect->follow instructions to setup shared Database locally.

- **Setup Environment Variables:**  Create .env (if not already, add to .gitignore), set MONGO_URI=your-mongodb-connection-string

- **Recommnedation:** Use MongoDB Compass for visualizing database structure

## TODO List:

- [x] Setup Initial Project Structure.

- [x] Connect MongoDB database.

- [ ] Frontend of site - Resource Library layout

- [ ] Frontend search bar + add resource button + upload resource modal form

- [ ] JS integration (onclick, onsubmit, etc.,)

- [ ] Backend logic + storing resources in database on submit of resource form

- [ ] AI Summary Feature

- [ ] Test and Refine website

- [ ] Google Analytics and get users

- [ ] Create presentation and video demo for submission