Skip to content

This monorepo contains all frontend projects and shared code for the SudoSOS platform, built with Vue 3 and TypeScript. Contributions are welcome!

Notifications You must be signed in to change notification settings

GEWIS/sudosos-frontend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ac8e179 · Jun 27, 2024
Jun 15, 2024
Jun 27, 2024
Jun 2, 2024
Jun 24, 2024
Jun 19, 2024
Jun 2, 2024
Jun 3, 2024
Jun 27, 2024
Jun 15, 2024
Jun 27, 2024
Jun 27, 2024

Repository files navigation

SudoSOS Frontend Monorepo

This monorepo contains all the frontend projects and common code for the SudoSOS.

Projects

  1. sudosos-nginx-proxy: Nginx proxy configuration for the SudoSOS stack.
  2. sudosos-frontend-common: Common code components, helper functions, services, and Pinia stores for frontend applications.
  3. sudosos-point-of-sale: Frontend application for the SudoSOS POS system built with Vue 3 and TypeScript.
  4. sudosos-dashboard: Dashboard frontend application for SudoSOS, rewritten in Vue 3.

Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvements, please open an issue on the issue tracker.

Development quick start

You can quickly start development directly in your browser by using Codespaces. Otherwise you can use a local code editor such Jetbrains Webstorm (free via the university) or VSCode.

GitHub Codespaces

Step 1: Setting up the environment

Step 2: Launching dashboard/point-of-sale

  • Run cd apps/dashboard or cd apps/point-of-sale in the terminal.
  • Run npm run dev to start the development environment.
  • There should be a pop up to open the website in the bottom right corner, changes to the code are directly reflected on this site.
  • You can also open this site using the ports tab in the same window as the terminal.

Warning

Login via GEWIS does not work on Codespaces, you will need to sign in using your m-account in the local login.

Tip

You can also use the Jetbrains IDE if you prefer that over the default Codespaces IDE. More information can be found here.

Local set up

Step 0: Prerequisites

Step 1: Installing

  • Use git to clone the repository.
  • Run npm install
  • Copy the .env.example file to .env in the apps/dashboard and apps/point-of-sale directories

Step 2: Running the dashboard/point-of-sale

  • Run cd apps/dashboard or cd apps/point-of-sale in the terminal.
  • Run npm run dev to start the development environment.
  • You can access the dashboard and point of sale at localhost:5173 and localhost:5174 respectively.

Set up browser for CORS

By default no network requests are allowed from other hosts to sudosos.test.gewis.nl. This will prevent critical network requests like authentication from working correctly. To allow this, CORS will need to be disabled. This can be done by using an extension that can disable CORS. Alternatively, if you are using chrome, you can directly run it without CORS.

About

This monorepo contains all frontend projects and shared code for the SudoSOS platform, built with Vue 3 and TypeScript. Contributions are welcome!

Topics

Resources

Security policy

Stars

Watchers

Forks

Packages

No packages published