MemoriesHub

MemoryHub is a personalized digital memory repository designed to capture and cherish the moments spent with your partner. It serves as a thoughtful gift, enabling users to curate date itineraries and store images accompanied by text descriptions, ensuring that every precious moment is preserved and easily accessible.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. License
6. Contact
7. Acknowledgments

About The Project

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To access the deployed / preview, use the following credentials.

• Username: user
• Password: password

To get a local copy up and running follow these simple steps.

Prerequisites

• Set up a firebase application.
• Set up a planetscale account and database.

Installation

1. Clone the repo

   git clone https://github.com/javianng/memories-hub.git

2. Install NPM packages

   npm install

3. Enter your API in .env. You can copy and use the .env.example provided wiht your own api keys.
4. In admin.tsx, uncomment the codes that are commented out and remove the existing button code.

(back to top)

Usage

Edge Middleware

Admin Portal

• To allow you to add Core Memories and Date Requests and their components.
• Access by going to the .../admin url.
• Disabled by default to prevent my deployed page to be amended.

Core Memories Home Page

• Filmstrip aesthetic that links to a dynamic page for each memory

Core Memory Individual Page

Date Request Home Page

Date Request Individual Page

(back to top)

Roadmap

• Full stack application created.
• Firebase upload in admin portal.

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Javian Ng - @j_avianzz - javian.ng.z.h@gmail.com

Project Link: https://github.com/javianng/memories-hub

(back to top)