brunosduarte/eznotes

EZ Notes

🗂 Contents

• 📋 Project
  • 🚀 Technologies
  • 📷 Preview
• 📦 Instalation
• ⚖️ License
• 📫 Contact

📋 Project

A web application where users can register and create organized notes on specific subjects. It allows adding the titles descriptions, links, and tags for each note and also includes user profile editing.

🚀 Technologies

📷 Preview

💻 frontend:

📦 Instalation

To clone and run this application, you will need Git, NodeJS v18.17.1 or higher + npm v9.17.1 or higher, and PNPm 8.7.5 installed on your computer. In your terminal, run:

# Cloning repo
$ git clone https://github.com/brunosduarte/eznotes.git eznotes

# Backend

# Go to the repository
$ cd server

# Install the dependencies
$ npm i

# Run the API
$ npm run dev

# Note: After running the command above, the API will be available at http://localhost:3333

# Frontend

# Got to the repository
$ cd web

# Install dependencies
$ npm i

# Execute
$ npm run dev

⚖️ License

This project is under license. MIT.

📫 Contact

by Bruno Duarte 🚀