Skip to content

README.md

Latest commit

 

History

History
55 lines (37 loc) · 1.23 KB

README.md

File metadata and controls

55 lines (37 loc) · 1.23 KB
Raw

Fullstack Assessment

Project Overview

This is a fullstack application built with TypeScript, using a monorepo structure with separate frontend and backend applications.

Requirements

Before you begin, ensure you have the following installed on your system:

  • Node.js (20.9.0 or higher)
  • pnpm (v8 or higher)
  • Docker Desktop
    • Make sure Docker Desktop is running before starting the project
  • Git
  • PostgreSQL client (optional, for direct database access)

Project Structure

.
├── apps
│   ├── frontend    # React TypeScript application
│   └── backend     # Node.js TypeScript API
└── package.json    # Root package.json for workspace management

Getting Started

  1. Clone the repository:
git clone https://github.com/edubasabe/linkly/tree/main
cd linkly
  1. Run the setup command:
pnpm run setup

Run the app locally (once setup has been completed)

  1. Run the app:
pnpm run start

Contact

David Basabe - @edubasabe

Project Link: https://github.com/edubasabe/linkly