ASU-CodeDevils / codedevils.org

The Official CodeDevils website frontend codebase written using Next.js, React, TypeScript, and Tailwind CSS
https://www.codedevils.org
9 stars 2 forks source link
nextjs nextjs14 tailwindcss typescript

CodeDevils' Website

This is the official repository for CodeDevils' website. It's built using the Next.js framework, Tailwind CSS, and TypeScript. The website is hosted on Vercel.

Why are there .js files in here?

As per T3-Axiom #3, we take typesafety as a first class citizen. Unfortunately, not all frameworks and plugins support TypeScript which means some of the configuration files have to be .js files.

We try to emphasize that these files are javascript for a reason, by explicitly declaring its type (cjs or mjs) depending on what's supported by the library it is used by. Also, all the js files in this project are still typechecked using a @ts-check comment at the top.

Contributing (Getting Started)

  1. Pre-requisites:

  2. Clone the repository:

    git clone https://github.com/ASU-CodeDevils/codedevils.org.git
  3. Install the dependencies:

    pnpm install
  4. Run the development server:

    pnpm dev

Contributing (Code Style)

This project uses Prettier and ESLint to enforce code style. Please make sure to run pnpm format, then pnpm lint before committing your changes.

Contributing (Commit Messages)

This project uses Conventional Commits to enforce a consistent commit message format. Please make sure to follow the commit message format when making changes.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Contributing (Pull Requests)

Please make sure to follow the pull request template when creating a pull request.