Skip to content

epfl-fsd/oslf

Repository files navigation

Où sont les frites?


Your essential guide to finding the best french fries on EPFL campus
Explore the docs »

View Website · Report Bug · Request Feature

About The Project

Où sont les frites? is the definitive application for locating french fries across EPFL's campus. Whether you're a student rushing between classes, a researcher on lunch break, or a visitor exploring the campus, our app helps you find the nearest spot serving fresh, hot fries.

Key Features

  • Real-time availability of fries at all campus restaurants and food trucks
  • Daily menu integration with campus restaurants
  • Queue time estimates during peak hours
  • Price comparison between different campus locations
  • Rating system for fries quality and portion size
  • Special offers and "fries of the day" notifications
  • Filter by location (Esplanade, Quartier Nord, Satellite, etc.)
  • Opening hours and lunch rush hours information

Built With

Our application leverages modern web technologies to provide the best user experience:

Next React Tailwind

Getting Started

This guide is divided into two sections:

  • Production Deployment: For users who want to run the application
  • Development Setup: For developers who want to contribute to the project

Production Deployment

Prerequisites

  • Docker

Environment Variables

Create a .env file with the following required variables:

# API Configuration (Required)
API_USERNAME=XXXXXXXXXXXXXXX  # Your API username
API_PASSWORD=XXXXXXXXXXXXXXX  # Your API password
API_URL=XXXXXXXXXXXXXXX       # API endpoint URL

Quick Start

  1. Pull the image from GitHub Container Registry:

    docker pull ghcr.io/epfl-fsd/ousontlesfrites:latest
  2. Run the container:

    docker run -d \
      --name ousontlesfrites \
      -p 3000:3000 \
      --env-file .env \
      ghcr.io/epfl-fsd/ousontlesfrites:latest
  3. Access the application at http://localhost:3000

Managing the Container

Stop the container:

docker stop ousontlesfrites

Start an existing container:

docker start ousontlesfrites

Remove the container:

docker rm ousontlesfrites

Development Setup

Prerequisites

  • Node.js (version 20 or higher)
  • npm
  • Docker (optional, for local container testing)

Local Development

  1. Clone the repository

    git clone https://github.com/epfl-fsd/ousontlesfrites.git
  2. Install dependencies

    npm install
  3. Create .env file with required variables (see Production section)

  4. Start development server

    npm run dev
  5. Access http://localhost:3000

Docker Development

Build a local Docker image:

docker build -t ousontlesfrites-dev .

Run the development image:

docker run -d \
  --name ousontlesfrites-dev \
  -p 3000:3000 \
  --env-file .env \
  ousontlesfrites-dev