https://github.com/saharaar/storefront-backend-project

Node.js and Express app with a PostgreSQL database, With a test suite for API and database actions. and security measures like bcrypt encryption.
https://github.com/saharaar/storefront-backend-project

express jasmine javascript postgresql typescript

Last synced: 5 days ago
JSON representation

Node.js and Express app with a PostgreSQL database, With a test suite for API and database actions. and security measures like bcrypt encryption.

• Host: GitHub
• URL: https://github.com/saharaar/storefront-backend-project
• Owner: SaharAAR
• License: other
• Created: 2024-01-10T08:32:10.000Z (12 months ago)
• Default Branch: master
• Last Pushed: 2024-01-14T06:23:25.000Z (11 months ago)
• Last Synced: 2024-12-18T20:13:54.531Z (5 days ago)
• Topics: express, jasmine, javascript, postgresql, typescript
• Language: TypeScript
• Homepage:
• Size: 21.5 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
### Storefront Backend Project

The project involves setting up a Node.js backend with Express and a PostgreSQL database, following best practices for security and code organization. The README.md provides concise instructions for database and project setup, emphasizing secure handling of environment variables. The project includes CRUD endpoints, organized routes, and model files aligning with database tables. SQL queries and migrations are well-formed, and user passwords are encrypted using bcrypt. Authentication is implemented using JWT tokens, integrated into HTTP responses and validated for secure routes. Comprehensive testing, including endpoint and unit tests, ensures the functionality of the API. The project adheres to JavaScript/TypeScript best practices and emphasizes code quality throughout.

# Getting Started

To get started with the project, follow these steps:

# Prerequisites

Ensure you have the following installed:

- Node.js

- PostgreSQL

# Installation

1. Clone this repository to your local machine.

2. Run the command yarn in your terminal at the project root to install dependencies.

# Database Schema

1. products (

    id SERIAL PRIMARY KEY,

    name VARCHAR(255) NOT NULL,

    price DECIMAL(10, 2) NOT NULL,

);

2. users (

    id SERIAL PRIMARY KEY,

    firstName VARCHAR(100) NOT NULL,

    lastName VARCHAR(100) NOT NULL,

    password VARCHAR(255) NOT NULL

);

3. orders (

    id SERIAL PRIMARY KEY,

    user_id INTEGER NOT NULL,

    FOREIGN KEY (user_id) REFERENCES users(id),

    status VARCHAR(20) NOT NULL

);

4. ordersProducts (

    id SERIAL PRIMARY KEY,

    order_id INTEGER NOT NULL,

    product_id INTEGER NOT NULL,

    quantity INTEGER NOT NULL,

    FOREIGN KEY (order_id) REFERENCES orders(id),

    FOREIGN KEY (product_id) REFERENCES products(id)

);

# Environment Variables

POSTGRES_HOST=127.0.0.1

POSTGRES_DB_TEST=storefront_test

POSTGRES_DB=storefront

POSTGRES_USER=sahar

POSTGRES_PASSWORD=password123

BCRYPT_PASSWORD= random

SALT_ROUNDS = 44

TOKEN_SECRET=secret123

ENV = dev

# Backend and Database Ports

- Backend Port: 3000

- Database Port: 5432

# Database Migrations

- Run database migrations using db-migrate up to set up your database schema.

 

## Running the Project

1. Start the server by running yarn start.

2. Access the main endpoint at (/).

3. Explore and interact with the endpoints:	

	- Products: http://localhost:3000/products		

	- Users: http://localhost:3000/users

	- Orders: http://localhost:3000/orders

    - OrdersPoducts: http://localhost:3000/ordersProducts

## Required Technologies

This application uses the following technologies:

- PostgreSQL for the database

- Node.js/Express for the application logic

- dotenv for managing environment variables

- db-migrate for database migrations

- jsonwebtoken for working with JWTs

- jasmine for testing