Local Development

We will cover how you can quickly run LogChimp and make your first contribution.

Please make sure you've enough hardware resources (Memory, CPU, Disk Space) to run the application on your machine or use cloud environments like GitHub Spaces

1. Docker
2. GitHub CodeSpaces

1. Docker

1. Clone the repository

git clone git@github.com:logchimp/logchimp.git <folder-name>
cd <folder-name>

2. Prep the .env files

Run this command from the root directory.

cp ./packages/server/.env.example ./packages/server/.env; \
  cp ./packages/theme/.env.example ./packages/theme/.env; \
  cp ./packages/e2e/.env.example ./packages/e2e/.env

3. Build the LogChimp Types package

We're still trying to figure out how to automate this step.

pnpm --filter="@logchimp/types" build

4. Start the Docker containers

Run this command from the root directory.

docker compose -f ./docker/local/docker-compose.dev.yml up -d

5. Start the LogChimp theme

If opening inside VSCode, open the command (Ctrl / Command + Shift + P), type Tasks: Run Task and hit enter, you will find the task in the list LogChimp Theme Dev and hit enter.

Or, you can run it manually

cd ./packages/theme
pnpm dev

2. GitHub CodeSpaces

There are no prerequisites for software or hardware requirements except for the Web Browser.

Once you run the CodeSpaces and the whole setup is complete.

If opening inside VSCode, open the command (Ctrl / Command + Shift + P), type Tasks: Run Task and hit enter, you will find the task in the list LogChimp Theme Dev and hit enter.

Other Ways to Help

While the primary means of contributing to LogChimp is through coding, there are still ways you can help even if you're not a developer. We always need help with:

• Maintaining LogChimp Docs
• Testing and quality assurance
• Promoting LogChimp to others