Project Huckleberry

The official repository for the website of GDSC NIT Rourkela

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

Project Huckleberry

Built With

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

• React
• NextJs
• Tailwind
• Prisma
• Auth.js

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 guidlines

Contributions are welcome 🎉🎉

NOTE 1: Please abide by the Contributing Guidelines.

NOTE 2: Please abide by the Code of Conduct.

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 as the package manager. It is strictly advised to use Yarn instead of NPM to avoid dependency conflicts.

1. Install Dependencies

   yarn install

2. Environment Setup

   • Create a new .env file in the root directory
   • Copy the contents from .sample.env as reference
   • Update the environment variables as needed

3. Database Setup

   # Generate Prisma Client
   yarn generate
   
   # Run database migrations
   yarn migrate

4. Development Server

   # Start the development server with Turbopack
   yarn dev

5. Additional Commands

   # Run linting
   yarn lint
   
   # Fix linting issues
   yarn lint:fix
   
   # Check code formatting
   yarn prettier:check
   
   # Fix code formatting
   yarn prettier:fix
   
   # Open Prisma Studio (database GUI)
   yarn studio

The development server will start at http://localhost:3000

License

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

DSC NIT Rourkela

Starware

dscnitrourkela/project-huckleberry 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 ✨

Thanks goes to these wonderful people (emoji key):

Ayush 💻	Harsh 💻	siddharth 💻	Dhrutinandan Swain 💻	Ayan 💻	Himanshu Kaushik 💻
Nishkarsh Gupta 🎨	somnath-07 🎨	pseudomidget 🎨	Srishty Mangutte 💻	BlessedAmrita 💻	Veena Sahu 💻
Ptrock2005 💻	AshutoshMishra1615 💻	Siddhi Narayan 💻	priyanshusahu2006 🎨
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!