cards's Introduction

Getting Started

Installation

# clone the project
git clone [email protected]:wiktor-falek/cards.git

# run install command
npm install

Folders structure

This project uses npm workspaces to set up a monorepo. Inside the package file in the root folder, there are some scripts that can be used to run or manage dependencies.

├── frontend                 // Workspace for the client
│   ├── public
│   ├── src                  // React app folder
│   ├── index.html
│   ├── package.json
├── socket-server            // Workspace for the backend
│   ├── src
│   ├── package.json
├── node_modules             // One single modules folder for the monorepo
├── package.json
└── .gitignore

From the root folder you can:

Run both workspaces, the frontend and the backend, concurrently by using one command:

npm run dev

Run the frontend or the backend separately:

npm run dev:client

npm run dev:backend

You can also install or uninstall dependencies by:

Using the following commands for the frontend workspace:

npm run i-client _package_name_  // To install
npm run uni-client _package_name_ // To uninstall

Using the following commands for the backend workspace:

npm run i-backend _package_name_  // To install
npm run uni-backend _package_name_ // To uninstall

Alternatively, you can navigate to the "frontend" and "socket-server" directories and use regular npm commands to manage dependencies and perform other tasks related to each workspace.