Skip to content

mqhaji/CampusFlock

 
 

Repository files navigation

CampusFlock Plan

CampusFlock is a web-based event management platform designed to recommend events to users with AI.

The platform is being developed with Vue.js for the frontend and MongoDB Atlas for the backend. It aims to provide a seamless user experience, offering features like event discovery, AI-generated event suggestions, and a user profile page.

Pages

  • Home Page: Displays a list of upcoming events. Uses a card-based layout to showcase events.
  • Suggested Page: Provides AI-driven event recommendations based on the user's preferences.
  • Profile Page: Displays user information and their avatar. Allows the user to manage their profile details.
  • Search Page: Allows users to search for specific events.

Technology used

Frontend:

  • TypeScript/JavaScript
  • Vue.js
  • Vuetify
  • Vue Router

Backend:

  • MongoDB
  • Node.js
  • Express
  • Mongoose
  • TypeScript (server runtime via tsx)

Running locally

Install dependencies:

npm install
cd server && npm install

Run both frontend and backend together:

npm run dev:all

Or run them separately:

cd server && npm run dev
npm run dev

Note: the server dev script uses tsx to run TypeScript directly.

Environment config:

  • VITE_API_BASE controls the frontend API base URL (see .env.example).

Optional server checks and data load:

cd server
npm run typecheck
cd server
npm run migrate:fixtures -- --drop

Current progress

  • General page layout and design
  • Search functionality
  • API Communication
  • MongoDB basic setup and schema

Plans for the future

  • Implement MongoDB Atlas
  • AI recommendation algorithm
  • User accounts and verified org accounts

Acknowledgements

Icons used from Material Design Icons under the Open Font License (OFL).

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Vue 61.1%
  • TypeScript 33.7%
  • CSS 3.4%
  • Other 1.8%