Developers Guide

Welcome to the Dafthunk developer guide. This guide is designed to help you understand our architecture, set up your development environment, and start contributing to Dafthunk. Dafthunk is an open-source project and you are welcome to contribute to it.

Getting Started

To start developing Dafthunk, you'll need to set up the project locally. Our codebase is hosted on GitHub. For detailed instructions on cloning the repository, installing dependencies (using pnpm), and running the development servers for both the web application and the API, please refer to the main README.md at the root of the project.

In summary, you will typically:

1. Clone the repository: git clone https://github.com/dafthunk-com/dafthunk.git
2. Install all dependencies: pnpm install
3. Run the application: pnpm dev

How to Contribute

We welcome contributions of all kinds! Here's how you can help:

Reporting Bugs

If you find a bug, please open an issue on GitHub. Include as much detail as possible: steps to reproduce, expected behavior, and actual behavior. Screenshots or code snippets are also helpful.

Suggesting Enhancements

Have an idea for a new feature or an improvement to an existing one? Feel free to open an issue to discuss it. If GitHub Discussions are enabled for the repository, that would also be an excellent place for broader ideas.

Pull Requests

We use the standard GitHub flow for pull requests:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes, adhering to our coding standards.
4. Commit your changes with clear and descriptive messages.
5. Push your branch to your fork.
6. Open a pull request against the Dafthunk repository.

Please ensure your PR description clearly explains the changes and why they are needed.

Technology Stack

Dafthunk leverages a modern technology stack to deliver a high-quality experience. Here's an overview: