Skip to content

Commit e4041b2

Browse files
authored
Create CONTRIBUTING.md
1 parent 127e37d commit e4041b2

1 file changed

Lines changed: 90 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# Contributing to Dashibase
2+
3+
Thank you for your interest in Dashibase! Before you begin, be sure to check out the [code of conduct](https://github.com/dashibase/dashibase/blob/main/CODE_OF_CONDUCT.md) and the [existing issues](https://github.com/dashibase/dashibase/issues).
4+
5+
## Prelude
6+
7+
Dashibase is written with the following frameworks and tools:
8+
9+
- [Vue 3](https://vuejs.org/) and [Vue Router 4](https://router.vuejs.org/)
10+
- [TypeScript](https://www.typescriptlang.org/)
11+
- [Tailwind CSS](https://tailwindcss.com/)
12+
- [Headless UI](https://headlessui.dev/)
13+
- [Hero Icons](https://heroicons.com/)
14+
15+
We strongly encourage contributors to be familiarized with these tools!
16+
17+
## Initial Setup
18+
19+
### Installing Dependencies
20+
21+
Before you can start helping with Dashibase, you will want to install and configure the following dependencies on your
22+
machine:
23+
24+
* [Git](http://git-scm.com/)
25+
26+
* [Node.js v16.x (LTS)](http://nodejs.org)
27+
28+
* [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
29+
30+
### Forking Supabase on GitHub
31+
32+
To contribute code to Dashibase, you need to fork the [repository](https://github.com/dashibase/dashibase).
33+
34+
## Setup Dashibase on Your Computer
35+
36+
### Clone the Repository
37+
38+
To build Dashibase, you clone your fork of the repository:
39+
40+
2. Clone your GitHub forked repository:
41+
```sh
42+
git clone https://github.com/<github_username>/dashibase.git
43+
```
44+
45+
3. Go to the Dashibase directory:
46+
```sh
47+
cd dashibase
48+
```
49+
50+
### Installing Dependencies
51+
52+
Install npm dependencies:
53+
54+
npm
55+
```sh
56+
npm install
57+
```
58+
59+
or with yarn
60+
```sh
61+
yarn install
62+
```
63+
64+
## Start a Development Server
65+
66+
1. Start development server
67+
68+
npm
69+
```sh
70+
npm run dev
71+
```
72+
73+
or with yarn
74+
```sh
75+
yarn dev
76+
```
77+
78+
2. To access the local server, enter the following URL into your web browser:
79+
80+
```sh
81+
http://localhost:3000/
82+
```
83+
84+
## Submit Your Contribution!
85+
86+
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!
87+
88+
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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) tutorial on how to resolve merge conflicts and other issues.
89+
90+
Once your PR has been merged, you will be proudly listed as a contributor in our [contributor chart](https://github.com/dashibase/dashibase/graphs/contributors)!

0 commit comments

Comments
 (0)