Skip to content

SETUP.md

Latest commit

 

History

History
55 lines (50 loc) · 1.14 KB

SETUP.md

File metadata and controls

55 lines (50 loc) · 1.14 KB

Setup

Prerequisites

  • Git
  • Bun
  • If on Windows, it's recommended to use WSL (Windows Subsystem for Linux) and do the following steps there.

Installation

  1. Clone the repository: 
    git clone https://github.com/Lapikud/tipilan.git
  2. Install bun: 
    curl -fsSL https://bun.sh/install | bash
  3. Install dependencies: 
    cd tipilan
bun install
  4. Run the application: 
    bun --bun run dev

(ONLY FOR PRODUCTION!!) Build the application:

bun --bun run build

Accessing the Application

  • The application is now running at http://localhost:3000.

Git branch

  • The current production branch is main.
  • Please make sure you make changes in your branch before creating a pull request.

Making git branch

  • Create a new branch: 
    git checkout -b <branch-name>
  • Commit your changes: 
    git add .
git commit -m "<commit-message>"
  • Push your branch: 
    git push origin <branch-name>
  • Create a pull request: Go to Github, open up this project's repository and make a new pull request.