|
1 | | -This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 1 | +# Gecian Hub |
2 | 2 |
|
3 | | -## Getting Started |
| 3 | +[](https://nextjs.org/) |
| 4 | +[](LICENSE) |
| 5 | +[](https://developers.cloudflare.com/workers/) |
4 | 6 |
|
5 | | -First, run the development server: |
| 7 | +A modern student portal for GECians, built with Next.js and designed to run on edge platforms like Cloudflare Workers. |
| 8 | +This app helps students manage complaints, expenses, projects, hackathons, and more—all in one place. |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +## 🚀 Features |
| 13 | + |
| 14 | +- 📋 Complaint management system |
| 15 | +- 💸 Expense tracker |
| 16 | +- 🤝 Project collaboration |
| 17 | +- 🏆 Hackathon info & links |
| 18 | +- 🔗 Quick access buttons to external student resources |
| 19 | +- 🗂 Tabs and cards UI |
| 20 | +- ⚡ Edge runtime compatible (Cloudflare Workers) |
| 21 | +- 🖋️ Modern design with [Geist](https://vercel.com/font) |
| 22 | +- 🔒 TypeScript for safety |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## 🛠️ Getting Started |
| 27 | + |
| 28 | +Clone the repo and install dependencies: |
| 29 | + |
| 30 | +```bash |
| 31 | +git clone https://github.com/shadilrayyan/gecian_hub.git |
| 32 | +cd gecian_hub |
| 33 | +npm install |
| 34 | +``` |
| 35 | + |
| 36 | +Run the development server: |
6 | 37 |
|
7 | 38 | ```bash |
8 | 39 | npm run dev |
9 | | -# or |
10 | | -yarn dev |
11 | | -# or |
12 | | -pnpm dev |
13 | | -# or |
14 | | -bun dev |
15 | 40 | ``` |
16 | 41 |
|
17 | | -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 42 | +Open [http://localhost:3000](http://localhost:3000) in your browser. |
| 43 | + |
| 44 | +--- |
| 45 | + |
| 46 | +## 📦 Deployment |
| 47 | + |
| 48 | +### Vercel |
| 49 | + |
| 50 | +[](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) |
| 51 | + |
| 52 | +### Cloudflare Workers |
| 53 | + |
| 54 | +- Edge API routes are compatible with Cloudflare Workers. |
| 55 | +- For persistent storage, use [Cloudflare KV](https://developers.cloudflare.com/workers/runtime-apis/kv/) or [D1](https://developers.cloudflare.com/d1/). |
18 | 56 |
|
19 | | -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 57 | +--- |
20 | 58 |
|
21 | | -This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 59 | +## 📚 Learn More |
22 | 60 |
|
23 | | -## Learn More |
| 61 | +- [Next.js Documentation](https://nextjs.org/docs) |
| 62 | +- [Cloudflare Workers Docs](https://developers.cloudflare.com/workers/) |
| 63 | +- [Vercel Docs](https://vercel.com/docs) |
24 | 64 |
|
25 | | -To learn more about Next.js, take a look at the following resources: |
| 65 | +--- |
26 | 66 |
|
27 | | -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
28 | | -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 67 | +## 🤝 Contributing |
29 | 68 |
|
30 | | -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 69 | +Pull requests and issues are welcome! |
| 70 | +See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. |
31 | 71 |
|
32 | | -## Deploy on Vercel |
| 72 | +--- |
33 | 73 |
|
34 | | -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 74 | +## 📝 License |
35 | 75 |
|
36 | | -Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
| 76 | +This project is licensed under the MIT License. |
0 commit comments