Skip to content

Helps to manage museum categories and it's items. Users can view museums, categories and items.

Notifications You must be signed in to change notification settings

Zeptosec/Museum

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

49 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Museum app

This is an app that helps to structure items in a museum and information about them.

Getting started

Clone repository:

git clone https://github.com/Zeptosec/Museum.git

Rename .env.example file to .env in museumback folder and fill it out with correct information.
Install all dependencies for backend:

cd museum/museumback
npm install

Install all dependencies for frontend:

cd museum/museumfront
npm install

Start backend in development:

cd museum/museumback
npm run dev

Start frontend in development:

cd museum/museumfront
npm run dev

Also check out API reference.

Purpose

To let visitor read about the museum and it's items on the internet. The platform is made of two parts: frontend, where users can view the page with nicely formatted data, and backend where data can be modified or fetched from database and served to user using API.

Functional requirements

  1. Admin can:
    1. Manage curators.
    2. Manage categories.
    3. Manage items.
  2. Curators can:
    1. Manage items in categories assigned to them.
  3. Guests can:
    1. Preview item details.
    2. Preview category details.
    3. Preview museum details.
    4. Register
    5. Login

Domain

Domain diagram

Deployment diagram

Deployment diagram

Wireframes

Museum list wireframe Implementation
Museums list Museum implementation
Museum creation form wireframe Implementation
Museum creation form