Giter Site home page Giter Site logo

searchland-monorepo's Introduction

Searchland Monorepo Application

๐Ÿ“ Directory Structure

  • backend/

    • Contains the server logic built with tRPC, typeORM, and Express, interfacing with a PSQL DB on Supabase.
    • Provides API endpoints to:
      • Get all users
      • Add a user
      • Delete a user
  • backend/src/api

    • Houses all the API specific definitions using tRPC and Express.
  • backend/src/db

    • Contains the DB-specific implementation leveraging typeORM and Supabase.
  • frontend/

    • Contains the React-based frontend application.

๐Ÿ”ง Prerequisites

  • Node.js and Yarn installed on your local development machine.

๐Ÿš€ Getting Started

Install Dependencies:

With Yarn workspaces, manage dependencies for both the backend and frontend from the root directory.

yarn install

๐ŸŒ Running the Backend

  1. Navigate to the Backend Directory:
cd backend
  1. Start the tRPC + Express Server:
yarn start

๐Ÿ–ฅ๏ธ Running the Frontend

  1. Navigate to the Frontend Directory:
cd frontend
  1. Start the React App:
yarn start

๐Ÿ•น๏ธ Interacting with the Backend API

Fetch All Users: Send a GET request to /api/users/getUsers

Add a New User: Send a POST request to /api/users/createUser with user name and age as query input.

Delete a User: Send a DELETE request to /api/users/deleteUser, along with the userID passed in the query input.

searchland-monorepo's People

Contributors

zadahmed avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.