Readme.md

Notes App

App to create notes. Once created, notes can be edited, archived or deleted.

Author

Smael Nicolas

Table of Contents

• Frontend Technologies
• Backend Technologies
• Docker Configuration
• Installation

Frontend Technologies

• Frontend Framework: React (^18.2.0)
• React DOM: React DOM (^18.2.0)
• React Icons: React Icons (^4.10.1)
• React Router DOM: React Router DOM (^6.15.0)

Backend Technologies

• Prisma: Prisma (^5.2.0)
• ts-node: ts-node (^10.9.1)
• TypeScript: TypeScript (^5.2.2)
• Prisma Client: Prisma Client (^5.2.0)
• CORS: CORS (^2.8.5)
• Express: Express (^4.18.2)

Docker Configuration

Docker configuration used in the project:

version: "3.8"
services:
    postgres:
        image: postgres:14.1-alpine
        restart: always
        environment:
            - POSTGRES_USER=root
            - POSTGRES_PASSWORD=root
        volumes:
            - postgres:/var/lib/postgresql/data
        ports:
            - "5432:5432"
volumes:
    postgres:

Installation

# clone this proyect
git clone https://github.com/SmaelNicolas/Note-CRUD.git

# Enter to /backend folder
githubSmaelNicolas-ensolvers-challenge\backend

Create .env file

 # Add DATABASE_URL to use the hosted backend
 DATABASE_URL="postgres://postgres:inHUVlAwB2GEdDcn@db.xfbldnmrrttkdgqnshbp.supabase.co:6543/postgres"

 # In case Supabase don't work, can use this one
DATABASE_URL="postgres://smaelnico:GfHjY0XfCgSYr4F3JwjUthxPP9vaQ3HB@dpg-cjofa83gl9oc73fjlnug-a.oregon-postgres.render.com/notes_crud"

# Go back to root folder

# USe to install dependencies on root
npm install

 #use to install dependencies in /backend and initialize it and install dependencies in /frontend and initialize it
npm run app

Open url