Skip to content

Commit faa3392

Browse files
Update README.md
1 parent 92238ed commit faa3392

File tree

1 file changed

+48
-5
lines changed

1 file changed

+48
-5
lines changed

README.md

Lines changed: 48 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,66 @@
1-
21
# ProjectArchive
32

4-
ProjectArchive is a static website designed for students at **GEC Sreekrishnapuram** to showcase their projects. This platform provides students with visibility, helps them secure internships, and allows recruiters to assess their potential.
3+
**ProjectArchive** is a static website designed for students at Enginerrring colleg to showcase their projects. This platform provides students with visibility, helps them secure internships, and allows recruiters to assess their potential.
4+
5+
---
56

67
## 🚀 Features
78
- 📌 **Centralized Repository** – A dedicated space to store and showcase student projects.
89
- 🌍 **Industry Exposure** – Helps students gain recognition and attract recruiters.
910
- 🔍 **Recruitment Support** – Enables alumni and hiring managers to find talented students.
1011
- 💡 **Inspiration & Collaboration** – Encourages students to innovate and collaborate on projects.
1112

13+
---
14+
1215
## 📽️ Demo Video
13-
[![Watch the Video](https://codecompasss.github.io/project_archive/public/video/demowebsitevideo.mp4)]
16+
[![Watch the Video](https://img.youtube.com/vi/YOUR_VIDEO_ID/maxresdefault.jpg)](https://codecompasss.github.io/project_archive/public/video/demowebsitevideo.mp4)
17+
18+
---
1419

1520
## 🛠️ Tech Stack
16-
- **Frontend:** Nextjs
21+
- **Frontend:** HTML, CSS, JavaScript
1722
- **Hosting:** GitHub Pages
1823

24+
---
25+
1926
## 👨‍💻 Team Members
2027
- **Shadil AM**
2128
- **Sorraj**
2229
- **Abhijith**
2330
- **Abhiram**
2431

32+
---
33+
34+
## 🏫 Want to Use This for Your Own College?
35+
36+
Absolutely! You can easily **reuse and customize** this project for your own institution or student community:
37+
38+
1. **Fork this repository**
39+
This lets you receive any future updates while keeping your own customizations.
40+
41+
2. **Clone your fork locally**
42+
```bash
43+
git clone https://github.com/yourusername/ProjectArchive.git
44+
```
45+
46+
3. **Update Branding**
47+
- Change the **name in the loading screen and navbar** to match your institution.
48+
This can be done in the **`components/` folder**.
49+
- Look for `Loading.js`, `Navbar.js`, or similarly named files.
50+
51+
4. **Edit Projects Data**
52+
- All project information is stored in:
53+
```
54+
data/project.json
55+
```
56+
- To **add**, **edit**, or **delete** project details, make changes directly in this file.
57+
58+
5. **Deploy with GitHub Pages**
59+
Once you're done customizing, deploy it using GitHub Pages:
60+
- Go to your repo settings → Pages → select the main branch and `/ (root)` folder.
61+
62+
---
63+
2564
## 📜 How to Contribute
2665
1. Fork the repository.
2766
2. Clone it: `git clone https://github.com/yourusername/ProjectArchive.git`
@@ -30,10 +69,14 @@ ProjectArchive is a static website designed for students at **GEC Sreekrishnapur
3069
5. Push changes: `git push origin feature-name`
3170
6. Open a Pull Request.
3271
72+
---
73+
3374
## 📩 Contact
3475
For any queries, feel free to reach out:
3576
- 📧 Email: [shadilrayyan2@gmail.com]
3677
- 🌐 Website: [ProjectArchive](https://codecompasss.github.io/project_archive/)
3778
3879
---
39-
*Empowering students by showcasing their projects!*
80+
81+
✨ *Empowering students by showcasing their projects!*
82+

0 commit comments

Comments
 (0)