swaindhruti / project-udon

Reunion website for 1999 batch of NIT Rourkela

1999 Reunion

The official repository for the website of reunion of 1999 alumini batch of NIT Rourkela.

View Live · Report Bugs . Add Features

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Prerequisites
   • Contribution guidlines
   • Local Repository Setup
   • Running the project
4. License
5. DSC NIT Rourkela
6. Starware
7. Contributors

About The Project

This project is the official website for the reunion of 1999 alumini batch of NIT Rourkela. The website is built using Vite and React. The website is hosted on Netlify. The website is built using Tailwind CSS and uses Cloudflare for DNS management.

The UI components are built using Shadcn/UI.

Built With

Following technologies and libraries are used for the development of this website

• React
• Vite
• Tailwind CSS
• Shadcn/UI
• Cloudflare
• Redux
• Firebase
• Netlify

Getting Started

To setup the project locally the steps below.

Prerequisites

• Node.js

  # homebrew
  brew install nodejs
  
  # sudo apt (Debian based systems)
  sudo apt install nodejs
  
  # pacman (Arch Linux)
  pacman -S nodejs
  
  # module Install (Fedora)
  dnf module install nodejs:<stream> # stream is the version
  
  # yum (CentOS, Red Hat)
  yum install nodejs
  
  # windows (chocolatey)
  choco install nodejs
  

• PNPM Install pnpm: If pnpm is not installed, you can install it globally using npm. Run one of the following commands:

npm install -g pnpm

or

Note

Best way to install it is using corepack. It is recommended to use pnpm as the package manager for this project. It is faster and more efficient than npm and yarn.

• Git

  # homebrew
  brew install git

  # sudo apt
  apt-get install git

  # pacman
  pacman -S git

  # module Install (Fedora)
  dnf install git

Contribution guidlines 🎃

---

Our Slack Community: Slack Invite

Contributions are welcome 🎉🎉

Local Repository Setup

Please refer to the project's style and contribution guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your local system
3. Commit changes to your own separate branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

Running the project.

The project uses PNPM and not NPM. It is strictly advised to stick with PNPM for this project to avoid dependency conflicts.

## Checkout into the project directory
cd project-unagi

## Install the dependencies
pnpm i

## Run the project
pnpm dev

## Build the project
pnpm build

Adding ShadCN/UI Components

Following are the commands to add new components from ShadCN/UI

## Add a new Component
pnpm dlx shadcn-ui@latest add <component-name>

Adding/Removing Dependencies

Following are the commands to remove/add new dependencies using yarn

## Add a new Package
pnpm i package_name

## Remove an existing Package
pnpm remove package_name

## Save Package as a Dev Dependency
pnpm i -D package_name

License

Distributed under the MIT License. See LICENSE for more information.

DSC NIT Rourkela

Starware

dscnitrourkela/project-unagi is Starware. This means you're free to use the project, as long as you star its GitHub repository. Your appreciation makes us grow and glow up. ⭐

Contributors

Ashish Padhy 💻 📆 ⚠️ 🚧 🚇 👀	Jayesh Nayak 💻👀	anmol5936 💻	Mixel2004 💻	Ashutosh Rath 💻	Srishty Mangutte 💻	Arya Bhattacharyya 💻
Prapti Prachita Pradhan 💻