Skip to content

Latest commit

 

History

History
66 lines (41 loc) · 1.25 KB

README.md

File metadata and controls

66 lines (41 loc) · 1.25 KB

Getting Started

To get a local copy up and running, please follow these simple steps.

Prerequisites

Here is what you need to run march.

  • Node.js (Version: >=18.x)
  • bun (recommended)

Development

Setup

  1. Clone the Repository with a Shallow Clone
git clone --depth=1 https://github.com/marchhq/march.git
  1. Switch to the project folder
cd march
  1. Create your feature or fix branch you plan to work on using
git checkout -b <feature-branch-name>
  1. Install packages with pnpm
bun install
  1. Set up your .env file

Go to the app/backend and app/frontend directories and duplicate the .env.example to .env.

  1. Run (in development mode)
bun dev

Linear integration

To set up the Linear integration:

  1. Sign up for a Linear account at https://linear.app if you haven't already.
  2. Create a new Linear OAuth application in your Linear settings.
  3. Fill in the following environment variables in your .env file:
LINEAR_REDIRECT_URL=http://localhost:3000/auth/linear
LINEAR_CLIENT_ID=<your_linear_client_id>
LINEAR_CLIENT_SECRET=<your_linear_client_secret>

Replace <your_linear_client_id> and <your_linear_client_secret> with the values provided by Linear for your OAuth application.