Project Setup Guide

Getting Started Locally

Prerequisites

To get started, you will need the following installed on your device:

• Node.js: Please make sure that Node.js is installed. This project was developed using Node.js v20.12.1, so it is recommended to use this version to avoid any version-related issues.
• PostgreSQL: You need a PostgreSQL database set up locally or on a remote server. Create a new database to use with the project.

Setting Up the Project

1. Clone the repository: Clone this project to your local machine by running:

   git clone https://github.com/rgnpcrz/todo-nextjs.git
   cd nextjs-assessment-rgnpcrz

2. Install Dependencies: Run the following command to install the project dependencies:

   npm install

3. Create a .env file: In the root of the project, create a .env file and update it with your PostgreSQL database connection string:

   DATABASE_URL="your-db-connection-string"

4. Set up the database:

   You can quickly set up the project and the database by running:

   npm run dev:setup

   This script will handle the project and database initialization for you.

   If you encounter any errors or prefer to do things manually, you can follow the steps below.

5. Manual Setup:

   If you prefer or need to set up manually, run the following commands in the order listed:

   npm install
   npx prisma migrate dev
   npm run dev

Running the Project

After setting everything up, you can run the project with:

npm run dev

This will start the development server and you can access the application locally.

Node.js Version

This project was developed and tested with Node.js v20.12.1. If you run into any issues related to Node.js version, consider using this specific version for local development.

---

Troubleshooting

If you face any issues during setup, here are some common solutions:

1. Prisma Client Generation: Ensure that the Prisma Client is generated correctly. You can do so by running:

   npx prisma generate

2. Database Connection Issues: Double-check the DATABASE_URL in your .env file and ensure your PostgreSQL server is running.

3. Outdated Dependencies: If you encounter errors related to packages, try running:

   npm update

---

Deployed Environment

You can also check the project on the deployed environment here: https://ve2max.rgnpcrz.com

---

NextJS 14 Test Project

Overview

This project is a test assignment to evaluate your skills and familiarity with NextJS 14, TypeScript, Prisma, TRPC, and Zustand. The application will be a full-stack application with both frontend and backend implemented within NextJS. The project is expected to take around 2 days to complete.

Project Requirements

1. NextJS 14 Application

• Use NextJS 14 for both the frontend and backend.
• Implement the application using TypeScript.
• Use a SQL database (preferably PostgreSQL, but others are fine too)

2. Frontend

• Implement a simple user interface that interacts with the backend via TRPC.
• Use Zustand for state management.
• Ensure the UI is clean, responsive, and user-friendly.

3. Backend

• Implement the backend logic within NextJS using API routes.
• Use Prisma for database interactions.
• Use TRPC for type-safe API calls.

4. Data Model

• Design a simple data model using Prisma. For instance, a model for managing a list of tasks (to-do list) or user profiles.

5. Features

• Implement CRUD operations for the chosen data model.
• Ensure all CRUD operations are exposed via TRPC endpoints.