Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 1.34 KB

README.md

File metadata and controls

25 lines (20 loc) · 1.34 KB

⚗️ Sweeper

This repository contains the front, gateway and most of the backend for the sweeper image sorting app.

Installation (under construction 🚧)

We will go over some basic steps to get a local version of the app running. This is only temporary and meant for early stage development.

Pre-requisites

Get-started

  • Clone this repository
  • Navigate to the sweeper/ directory
  • Setup your .env.dev file
  • Run docker compose -f docker-compose.dev.yml up --build (depending on you version it could also be docker-compose -f docker-compose.dev.yml up --build)
  • This will start the app in development mode where code changes will be applied instantly
  • In the browser, navigate to the landing page to check that the app is running
    • Use the login button of the landing page and you will be redirected to auth0 authenticication
    • There, you can 'sign-up' which will create a new user
    • Now, you should be able to navigate to an example overview page
  • To shutdown the application, use the command docker compose -f docker-compose.dev.yml down
  • 😺 Happy development!