NoteHub

A simple note sharing platform for students.

Features

• Create notes
• Share notes
• View notes
• Edit notes
• Save favourite notes
• Search notes
• Like notes
• View notes by category

Tech Stack

• Next.js
• TypeScript
• Tailwind CSS
• MySQL
• Docker

Database Schema

• Users

  • id
  • student_id
  • password
  • avatar
  • full_name
  • created_at
  • updated_at
  • last_post_created_at

• Notes

  • id
  • user_id
  • title
  • content
  • description
  • created_at
  • updated_at

• Images

  • id
  • user_id
  • note_id
  • url
  • created_at
  • updated_at

• Liked Notes

  • id
  • user_id
  • note_id
  • created_at
  • updated_at

Getting Started

In order to run this project, you need to have the following installed on your machine:

• Node.js
• npm
• Docker
• Docker Compose

Steps Running the Project

1. Install the dependencies

npm install

2. Run the DB container

docker-compose up -d

3. Run the development server

npm run dev

Now, the project should be up and runnint at http://localhost:3000.