Lucien Cartier-Tilet 604b83b51a
All checks were successful
Tests / tests (push) Successful in 3m51s
initial commit
2025-05-29 13:48:24 +02:00

2.9 KiB
Raw Blame History

daily-aujourdhui-frontend

Daily Aujourdhui is a platform where users can create daily meeting polls, invite participants, and vote on whether a meeting is necessary.

This repository contains the frontend code for the project.

The backend for this project can be found here.

Project Setup

Prerequisites

  • Node.js
  • npm

Installation

  1. Clone the repository:

    git clone https://labs.phundrak.com/phundrak/daily-aujourdhui-frontend.git
    cd daily-aujourdhui-frontend
    
  2. Install dependencies:

    Using npm:

    npm i
    

    Using yarn:

    yarn install
    

    Using pnpm:

    pnpm install
    
  3. Create a .env file

    cp .env.example .env
    

    Modify the environment variables to fit your installation of Daily Aujourdhui.

  4. Run the development server

    Using npm:

    npm run dev
    

    Using yarn:

    yarn dev
    

    Using pnpm:

    pnpm run dev
    

Building for Production

To build the project for production, run:

  • Using npm:

    npm run build
    
  • Using yarn:

    yarn build
    
  • Using pnpm:

    pnpm run build
    

Project Structure

src/
├── assets/            # Static assets such as images, fonts, styles, etc.
├── components/        # Vue components
│   └─ __tests__/      # Vue components tests
├── composables/       # Vue composables for reusable logic
│   └─ __tests__/      # Vue composables tests
├── router/            # Vue Router configuration
├── stores/            # Pinia stores for state management
│   └─ __tests__/      # Vue stores tests
├── views/             # Vue views/pages
├── App.vue            # Main Vue component
└── main.ts            # Main entry point

Environment Variables

You can create your .env file based on the example file .env.example. Here are the variables you need to set to make your frontend work correctly:

  • VITE_LOGTO_ENDPOINT: The enpoint used by your Logto application. This value should be given to you by Logto when you create your application in the Logto console.

  • VITE_LOGTO_APP_ID: The identifier of your application. Same as above.

  • VITE_HOSTNAME: The hostname of your frontend. When running in development, it will usually be http://localhost:5173, but it can become something like https://example.com when you deploy it in production.

    Warning: The hostname must NOT end with a trailing slash.

  • VITE_API_BASE_URL: The hostname of your backend. In development, it will probably be http://localhost:3000, but it can become something like https://api.example.com when in production.

License

This project is licensed under the AGPL-3.0 free license. See the LICENSE for more details.