|
1 | | -# Kiitian Finder 😋 |
2 | | -(v1) Find a kiit student `Name`, `Email` and `Student Number` using his/her roll number only. |
3 | | -(v2) Now you can find staff `Email`, `Social Profiles` and `Institution Mail`. |
| 1 | +# KIIT Site Shutdown Notice |
4 | 2 |
|
5 | | -This can be helpful if you need to find some staff or student in case of emergencies OR you are creating a database that includes staff and student details. |
| 3 | +A simple static webpage displaying a shutdown notice for the KIIT website as per administration request. |
6 | 4 |
|
7 | | -# How to run? 🤨 |
| 5 | +## Description |
8 | 6 |
|
9 | | -Make sure you have <a href="https://nodejs.org/en">nodeJS</a> installed. And this requires an active internet connection. |
| 7 | +This project consists of a static webpage that informs visitors about the shutdown of the KIIT website due to administrative requests. It includes a notice, contact information (Instagram), and a teaser for upcoming projects. |
10 | 8 |
|
11 | | -Paste this into your favourite terminal. |
12 | | -```bash |
13 | | -git clone https://github.com/erucix/kiitian-finder |
14 | | -cd kiitian-finder |
15 | | -node kiit.js 220XXXXX # <--this is your kiit roll number |
16 | | -``` |
| 9 | +## Features |
| 10 | + |
| 11 | +- Responsive design for all device sizes |
| 12 | +- Animated message display with typing effect |
| 13 | +- Social media contact links (Instagram and GitHub) |
| 14 | +- Modern UI with gradient background |
17 | 15 |
|
18 | | -# How to find faculties now? 🤨 |
| 16 | +## Files Structure |
19 | 17 |
|
20 | | -For getting faculties you need to install some extra modules. Paste this code intor your Commmand Prompt or Terminal to do all in once. |
21 | | -```bash |
22 | | -git clone https://github.com/erucix/kiitian-finder |
23 | | -cd kiitian-finder |
24 | | -npm install jsdom got |
25 | | -node faculty.js # <---- Saves output in faculty.json file. |
26 | 18 | ``` |
27 | | -**Note**: Running faculty search will cost you some time since we are fetching every staff details from the site. |
| 19 | +kiitians_backend/ |
| 20 | +├── index.html # Main HTML document |
| 21 | +├── styles.css # CSS stylesheet |
| 22 | +├── script.js # JavaScript for animations and interactions |
| 23 | +├── README.md # Documentation |
| 24 | +├── CNAME # Custom domain configuration for GitHub Pages |
| 25 | +└── .nojekyll # Disables Jekyll processing on GitHub Pages |
| 26 | +``` |
| 27 | + |
| 28 | +## Deployment Instructions |
| 29 | + |
| 30 | +### Local Deployment |
| 31 | + |
| 32 | +1. Clone the repository or download the files |
| 33 | +2. Open `index.html` in any modern web browser |
| 34 | + |
| 35 | +### GitHub Pages Deployment |
| 36 | + |
| 37 | +1. Create a new GitHub repository |
| 38 | +2. Push all files to the repository |
| 39 | +3. Go to Settings > Pages |
| 40 | +4. Select the branch to deploy (usually `main`) |
| 41 | +5. The site will be published at `https://<username>.github.io/<repository-name>/` |
| 42 | + |
| 43 | +### Custom Domain Deployment |
| 44 | + |
| 45 | +1. Update the `CNAME` file with your domain |
| 46 | +2. Configure your domain's DNS settings: |
| 47 | + - Add an A record pointing to GitHub Pages IP addresses |
| 48 | + - OR add a CNAME record pointing to `<username>.github.io` |
| 49 | + |
| 50 | +### Netlify Deployment |
| 51 | + |
| 52 | +1. Sign up for Netlify |
| 53 | +2. Connect your GitHub repository or drag and drop the project folder |
| 54 | +3. Configure build settings (not required for static sites) |
| 55 | +4. Deploy |
| 56 | + |
| 57 | +## Customization |
| 58 | + |
| 59 | +- Update the Instagram username in `script.js` |
| 60 | +- Update the GitHub username in `script.js` |
| 61 | +- Modify colors and styling in `styles.css` |
| 62 | +- Edit messages in `index.html` |
| 63 | + |
| 64 | +## Contact |
28 | 65 |
|
29 | | -⚠️ **Desclaimer**: This is only for recreational and educational purpose and I am in no way responsible for the misconduct done with the use of this program. |
| 66 | +For any questions, contact on: |
| 67 | +- Instagram: [@riteshchauhan_15](https://instagram.com/riteshchauhan_15) |
| 68 | +- GitHub: [ritesh-chauhan0x1](https://github.com/ritesh-chauhan0x1) |
0 commit comments