Skip to content

Step inside a contemporary digital museum and explore art through an elegant, minimalist virtual tour experience.

License

Notifications You must be signed in to change notification settings

LorenzoVentrone/museion

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

How to Run the Project (First Time Setup)

This project is a web application with:

  • Backend: Node.js (Express)
  • Frontend: Next.js
  • Database: PostgreSQL (started via Docker Compose)
  • ORM: Knex.js

Follow these steps to set up and run the project for the first time:


1. Start the Database with Docker Compose, Set Up the Database Schema and Seed Data

Open a terminal in the project root and run:

docker-compose up -d
cd backend
npx knex migrate:latest
npx knex seed:run
cd ..
docker exec -i postgres_db psql -U museion_user -d museion_db < init.sql

3. Test the Database Connection

You can check if the database is running and the tables are created:

docker exec -it postgres_db psql -U museion_user -d museion_db

Once inside the database shell, list the tables:

museion_db=# \dt

4. Start the Application

Open two terminals:

First terminal (Frontend):

cd frontend
npm install
npm run dev

Second terminal (Backend):

cd backend
npm install
npm run dev

5. Open the App

Visit http://localhost:3000/ in your browser.


6. Environment Variables

Create a .env file (not included in the repository) with the following content:

DB_HOST=postgres
DB_PORT=5432
DB_USER=museion_user
DB_PASSWORD=pwd
DB_NAME=museion_db

About

Step inside a contemporary digital museum and explore art through an elegant, minimalist virtual tour experience.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •