Skip to content

WebArtistryBAID/whale-frontend

Repository files navigation

Whale Frontend

This is the frontend for the ordering system for BAID's Whale Cafe. Built with React + TailwindCSS.

Get Started

To run in production, follow the tutorial under WebArtistryBAID/whale-docker.

To run in development:

  • Ensure that you have node.js and npm available.
  • Follow the tutorial under WebArtistryBAID/whale-backend to run the backend development server.
  • Copy .env.example to .env, and change VITE_API_HOST accordingly. Typically, you will change it to http://localhost:8000.
  • Change VITE_HOST according to where the frontend is hosted.
  • Change VITE_ONELOGIN_CLIENT_ID according to your OneLogin client ID.
  • Change VITE_ONELOGIN_HOST according to the location where OneLogin is hosted, no trailing slashes.
  • Run npm install.
  • Run npm run dev.

Contribution

To contribute, simply open a pull request.

License

    Whale is BAID's Whale Cafe's ordering system.
    Copyright (C) 2024  Team WebArtistry

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Releases

No releases published

Packages

No packages published