Blogify

Blogify is a place where users can log into to share their thoughts, idea and experiences.

System Design outlining the architecture of application, describes how different components interact, data flow, and the reasoning behind the design decisions.

Key Features

User-friendly design
Login and registration process
Create, update, view, and delete post
Engage with others through comments, with options to add and remove feedback

Getting Started

This is a Next.js project bootstrapped with create-next-app.

Prerequisites

Before you begin, ensure you have the following installed:

Node.js: Download and install Node.js

Installation

Clone the repository:

git clone [email protected]:MohammadShehadeh/blogify.git
cd blogify

Select the desired Node.js version:

nvm use

nvm: Installing and Updating

Environment Variables

The following environment variables are required for the proper functioning of the project. Create a .env file in the root directory and add the following values:

`NEXT_PUBLIC_VERCEL_URL`

The base URL for the Vercel deployment of your application.
Example: NEXT_PUBLIC_VERCEL_URL=https://your-vercel-app.vercel.app

`POSTGRES_PRISMA_URL`

The Prisma connection URL for the PostgreSQL database.
Example: POSTGRES_PRISMA_URL=postgres://user:password@host:port/database

`POSTGRES_URL_NON_POOLING`

The non-pooling connection URL for the PostgreSQL database.
Example: POSTGRES_URL_NON_POOLING=postgres://user:password@host:port/database

`AUTH_SECRET`

A secret key used for signing session cookies to maintain user sessions.
Example: AUTH_SECRET=your_secure_secret_key

Install dependencies:

npm ci

Run the project:

npm run dev

Open http://localhost:3000 with your browser to see the result.

Available Scripts

In the project directory, you can run:

Build for Production:

npm run build

Builds the app for production to the .next folder. It correctly bundles Next in production mode and optimizes the build for the best performance.

note: make sure to create a .env file in the root directory before running this command

Run in Production Mode:

npm run start

Execute this script to run the Next.js app in production mode. Once the app is running, you can access it in the browser at http://localhost:3000 This command is typically used after running the npm run build script.

Format Code with Prettier:

npm run prettier

Prettier is used for code formatting. To ensure consistent formatting throughout the project. This command will automatically format the code based on the rules defined in the .prettierrc.js configuration file.