Skip to content

Latest commit

 

History

History
194 lines (135 loc) · 4.82 KB

README.md

File metadata and controls

194 lines (135 loc) · 4.82 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

Tinkerhub Platform

Where everything for Tinkerhub happens!!!

Table of Contents
  1. About The Project
  2. Getting Started

About The Project

Tinkerhub Platform is a community built platform for Tinkers to conduct there activities.

(back to top)

Built With

(back to top)

Getting Started

Prerequisites

You need to install

  1. Node v16
  2. pnpm

Installation

  1. Clone the repo

    git clone https://github.com/tinkerhub/platform.git

  2. Install all the NPM packages all the applications.

    We are using PNPM workspace and turborepo to manage the applications in monorepo.

    pnpm install

  3. Copy the .env.example for each applications to .env in the same directory and fill the values required

  4. Start the api dev server and open http://localhost:8000

    pnpm --filter api dev

  5. Start the web application dev server and open http://localhost:3000

    pnpm --filter web dev

(back to top)

Installation with Docker compose

| Not ready yet. Coming soon

  1. You need to install
  1. Run
docker-compose up

(back to top)

Command Center

All the commands for applications can be executed from the root directory using PNPM Workspace and Turborepo.

  1. Web application PNPM commands

      pnpm --filter web <pnpm options>

  2. API Server PNPM commands

      pnpm --filter api <pnpm options>

  3. Turbo Pipeline Commands

      pnpm turbo run <pipeline_action_1> <pipeline_action_2>

  4. Package installation command

    pnpm add "package-name" --filter "workspace-name"

Misc Commands

  1. Run lint

      pnpm lint

  2. Run lint with autofixable fixes

      pnpm lint-fix

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)