Photo Finder App Backend

Table of Contents

• Description
• Installation Instructions
• Usage and Screenshots
• Technologies Used
• Dependencies and Credits
• Project Structure

Description

RESTful API created as as a part of The Odin Project curriculum.

Installation Instructions

1. Clone or fork this repo
2. cd into the project root directory (where the README.md file is located)
3. Run the following in your terminal

   1. npm init -y
      npm install
      psql

   2. CREATE DATABASE database_name;
      \c database_name
      \q

   3. npx tsc --init  
      npx prisma  
      npx prisma init  
      code .env

4. In the .env file

   • NODE_ENV=development
     TEST_DATABASE_URL=
     DEV_DATABASE_URL=
     DATABASE_URL=
     SECRET_KEY=

5. code prisma/schema.prisma
6. npm run dev
   • ^ + c will end the process
7. After making updates to ./src/queries.ts you'll want to run this to recompile queries.js
   • npx tsc

Usage and Screenshots

Here's a brief description of how to use the app.

• Link to live preview
• Link to frontend repo

Features

• Uses CORS to verify that the request is coming from a valid address

Technologies Used

Backend

• Node.js
• Express
• PostgreSQL
• Prisma ORM
• TypeScript
• Jest

Development Tools

• VS Code
• NPM
• Git

Hosting

• Github
• Neon
• Render

Dependencies and Credits

Package Dependencies

• @prisma/extension-accelerate
• @prisma/client
• bcryptjs
• cors
• dotenv
• express-validator
• jsonwebtoken
• pg
• @types/node
• supertest
• tsx

Other Credits

• Devicion
• Skillicons

Project Structure

├──controllers/            # Controller files
├──db/                     # Compiled queries.js file
├──prisma/                 # Prisma models and migrations
├──public/                 # Locally hosted image files
├──routes/                 # Router files
├──src/                    # Base queries.ts file
└──test/                   # Test files