Skip to content

Commit 7259926

Browse files
committed
update README
1 parent d110eea commit 7259926

File tree

2 files changed

+79
-37
lines changed

2 files changed

+79
-37
lines changed

CONTRIBUTING.MD

Lines changed: 0 additions & 28 deletions
This file was deleted.

README.md

Lines changed: 79 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,84 @@
1-
# FullyHacks 2025
1+
# 🚀 FullyHacks 2025
22

3-
## Welcome to FullyHacks 2025 - CSUF's first 24-hour in-person hackathon
3+
**Welcome to FullyHacks 2025 — CSUF's first 24-hour in-person hackathon!**
4+
This repository contains the codebase for the official website and supporting tools. See more [info.](https://acmcsuf.com/hackathons) about FullyHacks!
45

5-
## Tech Stacks:
6+
---
67

7-
1. Next.js (Full-stack framework)
8-
2. TailwindCSS, DaisyUI (Styling)
9-
3. Prisma (ORM)
10-
4. MongoDB (Database)
8+
## 🛠 Tech Stack
119

12-
## CONTRIBUTING
10+
- **Framework:** [Next.js](https://nextjs.org/)
11+
- **Styling:** [TailwindCSS](https://tailwindcss.com/), [DaisyUI](https://daisyui.com/)
12+
- **ORM:** [Prisma](https://www.prisma.io/)
13+
- **Database:** [MongoDB](https://www.mongodb.com/)
1314

14-
### [READ HERE](https://github.com/acmcsufoss/fullyhacks/blob/main/CONTRIBUTING.MD)
15+
---
16+
17+
## ⚙️ Local Development Setup
18+
19+
### 1. Fork & Clone the Repo
20+
21+
```bash
22+
git clone https://github.com/acmcsufoss/fullyhacks.git
23+
cd fullyhacks
24+
```
25+
26+
### 2. Install Dependencies
27+
28+
```bash
29+
npm install
30+
```
31+
32+
### 3. Create a `.env` File
33+
34+
Add the following to your `.env` file to enable local development:
35+
36+
```env
37+
NEXT_PUBLIC_API_URL="http://localhost:3000"
38+
NEXTAUTH_URL="http://localhost:3000"
39+
NODE_ENV=dev
40+
```
41+
42+
> 💡 Refer to `.env.example` for all supported environment variables.
43+
44+
---
45+
46+
## 🏃‍♂️ Running the Project
47+
48+
### Start the Website
49+
50+
```bash
51+
npm run dev
52+
```
53+
54+
### Open Prisma Studio (for database inspection)
55+
56+
```bash
57+
npx prisma studio
58+
```
59+
60+
---
61+
62+
## ✅ Before You Commit
63+
64+
- Format your code using:
65+
66+
```bash
67+
npm run format
68+
```
69+
70+
---
71+
72+
## 🔐 Environment Variables & Privacy
73+
74+
- Server environment variables are **confidential** to protect participant data.
75+
- Only the **FullyHacks Web Team** should use the production variables.
76+
- You’re welcome to connect your own database locally to explore.
77+
78+
---
79+
80+
## ⚠️ Important Note
81+
82+
This repo is **not** connected to the live Vercel deployment.
83+
Due to Vercel’s team organization costs, the deployed repo is located here:
84+
👉 [anhduy1202/fullyhacks](https://github.com/anhduy1202/fullyhacks)

0 commit comments

Comments
 (0)