acm-ucr / h4b-website

Building a community to combat food insecurity in Inland Empire
https://h4b.ucrhighlanders.org
3 stars 0 forks source link

Hungry 4 Biscuits Website

Next.js JavaScript TailwindCSS Figma
ESLint Prettier GitHub Actions

Figma

Hungry 4 Biscuits Figma Design File

Node.js

Hungry 4 Biscuits runs on Node.js Version 20.10.0 and higher. Please ensure you have Node.js installed via the official website.

Next.js

This project is built using Next.js, a React framework. Next.js is automatically installed when you install all dependencies for this project.

Environment Variables

The following environment variables are required and must be stored in an .env file:

N/A

Commands

Dependencies

# Install dependencies
npm i

# Add dependency
npm i <dependency>

# Remove dependency
npm un <dependency>

Running the Website Locally

# Open a browser at localhost:3000
npm run dev

Formatting Code via Prettier

# Rewrite code recursively with proper formatting
npm run format

# Show formatting differences recursively
npm run check

Linting Code via Eslint

npm run eslint

Build the Website

npm run build