Skip to content

emredumaan/memory-lane

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Memory Lane

Memory Lane is a diary web application. It allows users to create accounts, log in, create diaries called "lanes", set them as public or private, and read public lanes created by other users. The app also features account management functionalities such as changing passwords, names, and deleting accounts.

Demo

Demo link: https://memory-lane-demo-kohl.vercel.app/
Demo version has some restrictions and some feautures of it may not work as expected.

"Test User" credentials:
Email: test@user.tld
Password: password

Technologies Used

  • Frontend:

    • React
    • TypeScript
    • Tiptap (for rich text editing)
  • Backend:

    • Node.js
    • Express.js
    • MySQL
    • Sequelize (ORM for interacting with MySQL)

Features

  • Account creation and authentication
  • Creating, viewing, and deleting diaries (lanes)
  • Setting lanes as public or private
  • Rich text editing capabilities for creating diaries
  • Mobile-friendly design
  • Account management (password change, name change, account deletion)

Testing and Development

To run the Memory Lane web application locally in dev mode, follow these steps:

  1. Clone the repository:
git clone https://github.com/emredumaan/memory-lane.git
  1. Navigate to the project directory:
cd memory-lane
  1. Install dependencies for the client (frontend) and server (backend):
cd client
npm install
cd ../server
npm install
  1. Update the config file:

    • Update the database configuration in server/config.json with your credentials.
  2. Start the backend server:

cd server
npm run dev
  1. Start the frontend server:
cd client
npm run dev
  1. You can access the app in your browser at http://localhost:5173.

Screenshots

Screenshot 1 Home page

Screenshot 2 Public lanes page

Screenshot 3 Sign in page

Screenshot 4 Create lane page

Screenshot 5 My lanes page

Screenshot 6 Account settings page

Credits

Memory Lane is created by Emre DUMAN. Feel free to contribute by submitting issues or pull requests.