Skip to content

Latest commit

 

History

History
186 lines (130 loc) · 5.12 KB

README.md

File metadata and controls

186 lines (130 loc) · 5.12 KB
Raw

Starware


Logo

Frameboi

Profile Picture Frame Generator for HackNITR 4.0

View Live · Report Bugs . Add Features

Table of Contents
  1. About The Project
  2. Built With
  3. HackNITR
  4. Getting Started
  5. License
  6. DSC NIT Rourkela
  7. Starware

About The Project

A digital and customisable frame generator for all the participants of the hackathon

  • The web application allows you to customise your frames with wide-range of shapes and colors.
  • On completion of the frame, upload your profile picture.
  • Download the customised frame and share it with others.

Built With

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

HackNITR

HackNITR, one of the largest hackathons in India's eastern region, is a kind of hackathon that endeavours to bring and integrate talent, innovation, and creativity under one roof to build solutions for real-world problems using the latest technologies. It is organized by a bunch of tech enthusiasts from Developer Student Clubs (DSC) NIT Rourkela in collaboration with OpenCode, Opensource community, registered under the technical society of Student Activity Centre (SAC), NIT Rourkela.

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
  # 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

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

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.

DSC NIT Rourkela

Project developed and maintained by DSC NIT Rourkela DSC NIT Rourkela Cover Image

Starware

dscnitrourkela/project-icecream 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. ⭐