Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

90 lines (58 loc) · 2.43 KB

Contributing to Dashibase

Thank you for your interest in Dashibase! Before you begin, be sure to check out the code of conduct and the existing issues.

Prelude

Dashibase is written with the following frameworks and tools:

We strongly encourage contributors to be familiarized with these tools!

Initial Setup

Installing Dependencies

Before you can start helping with Dashibase, you will want to install and configure the following dependencies on your machine:

Forking Supabase on GitHub

To contribute code to Dashibase, you need to fork the repository.

Setup Dashibase on Your Computer

Clone the Repository

To build Dashibase, you clone your fork of the repository:

  1. Clone your GitHub forked repository:

    git clone https://github.com/<github_username>/dashibase.git

  2. Go to the Dashibase directory:

    cd dashibase

Installing Dependencies

Install npm dependencies:

npm
```sh
npm install
```

or with yarn
```sh
yarn install
```

Start a Development Server

  1. Start development server

    npm

    npm run dev

    or with yarn

    yarn dev

  2. To access the local server, enter the following URL into your web browser:

    http://localhost:3000/

Submit Your Contribution!

After you've made the improvements, you can open a pull request and a member of the Dashibase team (well either SK or Alfred for now!) will work with you on the PR!

Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out GitHub's pull request tutorial on how to resolve merge conflicts and other issues.

Once your PR has been merged, you will be proudly listed as a contributor in our contributor chart!