Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

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

MemoryHub: Personalized digital memory repository for couples to curate date itineraries, store images, and cherish moments together.
https://github.com/javianng/memories-hub

couple reactjs relationship t3-stack trpc typescript

Last synced: 3 days ago
JSON representation

MemoryHub: Personalized digital memory repository for couples to curate date itineraries, store images, and cherish moments together.

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]





Logo

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



  2. Getting Started


  3. Usage

  4. Roadmap

  5. License

  6. Contact

  7. Acknowledgments

## About The Project

![alt text](/public/readme/image.png)

(back to top)

### Built With

- [![Next][Next.js]][Next-url]
- [![React][React.js]][React-url]
- [![tailwindCSS][tailwindCSS-shield]][tailwindCSS-url]
- [![materialUi][materialUi-shield]][materialUi-url]
- [![daisyUi][daisyUi-shield]][daisyUi-url]
- [![planetscale][planetscale-shield]][planetscale-url]
- [![trpc][trpc-shield]][trpc-url]
- [![firebase][firebase-shield]][firebase-url]

(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
```sh
git clone https://github.com/javianng/memories-hub.git
```
2. Install NPM packages
```sh
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

![alt text](public/readme/image-1.png)

### Admin Portal

![alt text](public/readme/image-2.png)

- 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

![alt text](public/readme/image-3.png)

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

### Core Memory Individual Page

![alt text](public/readme/image-4.png)

### Date Request Home Page

![alt text](public/readme/image-5.png)
![alt text](public/readme/image-8.png)

### Date Request Individual Page

![alt text](public/readme/image-6.png)
![alt text](public/readme/image-7.png)

(back to top)

## Roadmap

- [x] Full stack application created.
- [ ] Firebase upload in admin portal.

See the [open issues](https://github.com/javianng/memories-hub/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](https://twitter.com/j_avianzz) - [email protected]

Project Link: [https://github.com/javianng/memories-hub](https://github.com/javianng/memories-hub)

(back to top)

[contributors-shield]: https://img.shields.io/github/contributors/javianng/memories-hub.svg?style=for-the-badge
[contributors-url]: https://github.com/javianng/memories-hub/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/javianng/memories-hub.svg?style=for-the-badge
[forks-url]: https://github.com/javianng/memories-hub/network/members
[stars-shield]: https://img.shields.io/github/stars/javianng/memories-hub.svg?style=for-the-badge
[stars-url]: https://github.com/javianng/memories-hub/stargazers
[issues-shield]: https://img.shields.io/github/issues/javianng/memories-hub.svg?style=for-the-badge
[issues-url]: https://github.com/javianng/memories-hub/issues
[license-shield]: https://img.shields.io/github/license/javianng/memories-hub.svg?style=for-the-badge
[license-url]: https://github.com/javianng/memories-hub/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/javianngzh
[product-screenshot]: images/screenshot.png
[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[tailwindCSS-shield]: https://img.shields.io/badge/tailwindcss-20232A?style=for-the-badge&logo=tailwindcss
[tailwindCSS-url]: https://tailwindcss.com/
[materialUi-shield]: https://img.shields.io/badge/mui-20232A?style=for-the-badge&logo=mui
[materialUi-url]: https://tailwindcss.com/
[daisyUi-shield]: https://img.shields.io/badge/daisyui-20232A?style=for-the-badge&logo=daisyui
[daisyUi-url]: https://daisyui.com/
[planetscale-shield]: https://img.shields.io/badge/planetscale-20232A?style=for-the-badge&logo=planetscale
[planetscale-url]: https://planetscale.com/
[trpc-shield]: https://img.shields.io/badge/trpc-20232A?style=for-the-badge&logo=trpc
[trpc-url]: https://trpc.io/
[firebase-shield]: https://img.shields.io/badge/firebase-20232A?style=for-the-badge&logo=firebase
[firebase-url]: https://firebase.google.com/