Skip to content

README.md

Latest commit

 

History

History
124 lines (88 loc) · 1.94 KB

README.md

File metadata and controls

124 lines (88 loc) · 1.94 KB
Raw

CAPY WEB UI

CI

User management, analytics, event planning, and more!

File Structure

webui/
├── .github/
├── cypress/    
├── public/
├── src/        
|   ├── assets/
|   ├── components/
|   ├── contexts/
|   ├── css/
|   ├── hooks/
|   ├── pages/
|   ├── types/
|   ├── utils/
|   ├── App.tsx
|   ├── main.tsx  
├── index.html
├── package.json
├── <configs>

Cloning the Repo

Using HTTPS

git clone https://github.com/CAPY-RPI/webui.git

Using SSH

git clone git@github.com:CAPY-RPI/webui.git

Prerequisites

  • Node.js (v18 or newer)
  • npm (comes bundled with Node.js)
  • Docker (for running the production container locally)

Running Locally (Development)

From the root level of the repository:

Install Dependencies

npm install

Run the Site

npm run dev

This starts the development server with Hot Module Replacement. Any changes you make will be instantly displayed without reloading!

Linting / Formatting

Running Stylelint (optional --fix)

npx stylelint "**/*.css" --fix

Running ESLint

npx eslint . --fix

Running Prettier

Prettier Check

npx prettier . --check

Apply Fixes

npx prettier . --write

Run all Linters

Check Lint Script

npm run lint-check

Fix Lint Script

npm run lint-fix

Cypress E2E Testing

We must replicate a production environment to adequately test the UI.

docker build -t web-ui:test .
docker run -d --name webui -p 5173:80 web-ui:test
npx cypress open

To rebuild environment, stop and remove the previous build before following the previous steps.

docker stop webui
docker rm webui