https://github.com/zeptosec/museum
Helps to manage museum categories and it's items. Users can view museums, categories and items.
https://github.com/zeptosec/museum
beginner expressjs fullstack jwt jwt-authentication ktu learning nuxt3 pinia prisma simple smallproject typescript
Last synced: about 1 month ago
JSON representation
Helps to manage museum categories and it's items. Users can view museums, categories and items.
- Host: GitHub
- URL: https://github.com/zeptosec/museum
- Owner: Zeptosec
- Created: 2023-09-15T18:39:01.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-16T07:28:14.000Z (over 2 years ago)
- Last Synced: 2025-03-11T08:36:12.211Z (about 1 year ago)
- Topics: beginner, expressjs, fullstack, jwt, jwt-authentication, ktu, learning, nuxt3, pinia, prisma, simple, smallproject, typescript
- Language: Vue
- Homepage: https://museum1.vercel.app
- Size: 1.25 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Museum app
This is an app that helps to structure items in a museum and information about them.
## Getting started
Clone repository:
```sh
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:
```sh
cd museum/museumback
npm install
```
Install all dependencies for frontend:
```sh
cd museum/museumfront
npm install
```
Start backend in development:
```sh
cd museum/museumback
npm run dev
```
Start frontend in development:
```sh
cd museum/museumfront
npm run dev
```
Also check out [API reference](https://github.com/Zeptosec/Museum/wiki/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
## Deployment diagram
## Wireframes
Museum list wireframe | Implementation
:--------------------:|:--------------------------:
 | 
Museum creation form wireframe | Implementation
:--------------------:|:--------------------------:
 | 