Kaagaz

Website of D361

View Live · Report Bugs . Add Features

Table of Contents

1. About The Project
2. Built With
3. Getting Started
   • Prerequisites
   • Contribution guidelines
   • Local Repository Setup
   • Running the project
4. License
5. Starware

About The Project

This project aims to develop the website of D361 club of NIT Rourkela. D361 is an open platform for all students of NITR to showcase their literary or creative talents. The frontend of the website is built using Next.js and emotion.

Built With

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

• Next.js
• TypeScript
• Emotion
• Vercel

Getting Started

To setup the project locally the steps below.

Prerequisites

• Node.js

  # Homebrew
  brew install nodejs

  # Sudo apt
  sudo apt install nodejs

  # Packman
  pacman -S nodejs

  # Module Install
  dnf module install nodejs:<stream> # stream is the version

  # Windows (chocolaty)
  cinst nodejs.install

• Yarn

  npm install --global yarn

• Git

  # Homebrew
  brew install git

  # Sudo apt
  apt-get install git

  # Packman
  pacman -S git

  # Module Install (Fedora)
  dnf install git

Contribution guidelines

---

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

Running the project.

The project uses Yarn and not NPM. It is strictly advised to stick with Yarn so as to avoid dependency conflicts down the line.

## Install Dependencies
yarn install

## Run the Project
yarn develop

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

## Add a new Package
yarn add package_name

## Remove an existing Package
yarn remove package_name

## Save Package as a Dev Dependency
yarn add -D package_name

License

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

Starware

This project 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. ⭐