Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
s1lva committed Oct 11, 2024
1 parent afd094f commit 543a274
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 2 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## How to Contribute

1. Clone the project

```bash
git clone https://github.com/s1lvax/route
```

2. Install dependencies

```bash
pnpm i
```

3. Run a Postgres instance (I recommend using Docker)

```bash
docker run --name your_postgres_container -e POSTGRES_USER=your_username -e POSTGRES_PASSWORD=your_password -e POSTGRES_DB=your_database -p 5432:5432 -d postgres
```

4. Update the `example.env` to `.env` and fill in your data
5. Push the databse schema using Prisma

```bash
npx prisma db push
```

6. Start the dev server

```bash
pnpm dev
```

7. Develop the change using a separate branch, either `bugfix/name` or `feature/name`
8. Push your changes and open a Pull Request with details about your changes
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,19 @@ docker run --name your_postgres_container -e POSTGRES_USER=your_username -e POST
```

4. Update the `example.env` to `.env` and fill in your data
5. Develop the change using a separate branch, either `bugfix/name` or `feature/name`
6. Push your changes and open a Pull Request with details about your changes
5. Push the databse schema using Prisma

```bash
npx prisma db push
```

6. Start the dev server

```bash
pnpm dev
```

7. Develop the change using a separate branch, either `bugfix/name` or `feature/name`
8. Push your changes and open a Pull Request with details about your changes

#### All Pull Requests are very appreciated :D

0 comments on commit 543a274

Please sign in to comment.