forked from s1lvax/route
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
s1lva
committed
Oct 11, 2024
1 parent
afd094f
commit 543a274
Showing
2 changed files
with
49 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters