Lime 🍋

An easy way to build ecommerce stores fast.

Getting Started

Prerequisites

You will need to install docker on your local machine.

Installation

To get started with Lime locally, follow these steps

1. Get a local copy of your repo

    git clone https://github.com/coding1101/lime

2. Navigate to the project directory

   cd lime

3. Install NPM packages(We suggest using pnpm)

   pnpm install

4. Start a docker container for the database.

   docker-compose up

5. Copy .env.example file and rename it to .env and edit the values. Keep the DATABASE_URL the same unless you changed the docker-compose.yml file.

6. Once your database is ready, push your schema to the database.

   pnpm prisma db push

7. Finally start your dev server.

   pnpm dev

8. To view the database

   pnpm prisma studio

Open your browser and visit http://localhost:3000 to see the application running.

How to Contribute

Run pnpm format before conrtibuting.

Working on New Features

If you want to work on a new feature, follow these steps.

1. fork the repo
2. clone your fork
3. checkout a new branch
4. do you work,
5. commit
6. push your branch to your fork
7. go into github UI and create a PR from your fork & branch, and merge it into upstream MAIN

Pulling in changes from upstream

You should pull in the changes that we add, preferably before you checkout a new branch to do new work.

1. git checkout main
2. git pull upstream main