README.md

Tint Your Day

About the Project

Tint Your Day is an interactive drawing journal app that allows you to express your mood through coloring on a watercolor canvas and typing text. You are free to add comments or add color to old journals as a record of your change of mindset. You can make it a daily journal book or a subject-based one to document your thoughts and ideas. Each journal's contents (including text and watercolor images) are stored on our server and can be accessed from multiple devices. I hope that Tint Your Day will make journaling an enjoyable and meaningful experience for you.

This app was built on MERN stack development (MongoDB, Express, React Native, Node) and Apollo + GraphQL. It was also my final project for Web Programming Course at the National Taiwan University in 2022 Fall.

Watch my 5-min presentation(in Mandarin) for more details.

Getting Started

Setup

• Download Android Simulator or Expo Go App on IOS
• cd frontend && yarn install
• cd backend && yarn install

Run

• Frontend:

  • Run yarn start
  • Open an android simulator or use a mobile phone to scan the QR code on the terminal.
  • The app will connect to our server by default. If you want to run on your server, follow the next step. (Notes: Default server running at NTU CSIE Workstation has a 2GB limit, and might be closed in the future.)

• Backend:

  • Setup global variables: MONGO_URL, JWT_SECRET(a random string. this is for creating tokens), PORT and BASE_URL. You can put them in a single .env file in backend/.
  • Change BASE_URL, PORT variables in frontend/src/data/constants.js according to your settings.
  • Run yarn server

Todo Features

1. Instruction on how to use in the app
2. Recorder feature
3. Archive the journals
4. Calendar view
5. Offline mode
6. Web Version

Contact

email: [email protected]