Skip to content

Connect, collaborate, and grow with a community of TypeScript developers

Fix Broken Images and Update PlanetScale Steps (#427)

laureanray8d1858a77f4d
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b5928861..04e34445 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -82,12 +82,11 @@ the community to understand your suggestion and find related suggestions.
Enhancement suggestions are tracked as [GitHub issues](/issues).
-- Use a **clear and descriptive title** for the issue to indentify the
- suggestion.
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as much
detail as possible.
- **Describe the current behavior** and **explain which behavior you expected to
- see instead** and why. At this point you can also tell which alternatives do
+ see instead** and why. At this point, you can also tell which alternatives do
not work for you.
- You may want to include **screenshots** which help you demonstrate the steps
or point out the part which the suggestion is related to.
diff --git a/LOCAL.md b/LOCAL.md
index 0bbc7107..26c1f583 100644
--- a/LOCAL.md
+++ b/LOCAL.md
@@ -5,23 +5,18 @@
[trash-discord]: https://discord.gg/trashdev
To contribute you will first need to fork the repo and make some adjustments to
-get it up and running on your local machine. Below are the steps to follow in
-order for you to get TypeHero to run on your local machine.
+get it up and running on your local machine. Below are the steps to follow for you to get TypeHero to run on your local machine.
### 1. Create a `.env` file
-```
-cp .env.example .env
-```
-
-Provide your own values as needed.
+Provide your values as needed.
### 2 Configure your database
-You can either use planetscale or a local docker container to run your database.
+You can either use PlanetScale or a local Docker container to run your database.
Use either 2.a or 2.b for the next step.
-### 2.a Docker local DB
+### 2.a Local Database (using Docker)
Starting the docker container
@@ -29,20 +24,18 @@ Starting the docker container
docker compose up -d
```
-### 2.b Planetscale cloud DB
+### 2.b Remote Database (using PlanetScale)
+
+[Follow the PlanetScale quick start guide to get started][planetscale-quick-start]
-[Follow the planetscale quick start guide to get you connection string][planetscale-quick-start]
+After creating an account and creating a database using the steps above:
+1. Click either the big "Connect" button or the "connect to your database" Link.
+![connect](./media/connect.png)
-1. Click Get Started -> Continue with GitHub
-2. Click Blue "create".
- <br/><img width="444" alt="Screenshot 2023-06-30 at 3 44 27 PM" src="https://github.com/bautistaaa/typehero/assets/31113245/c30929fe-68ca-407d-9894-ef2ea52ced3c">
-3. Click "Get connection strings".
- <br/><img width="429" alt="Screenshot 2023-06-30 at 3 46 45 PM" src="https://github.com/bautistaaa/typehero/assets/31113245/c06a5829-92e6-417f-a5e6-083b7690923f">
+2. Select "Connect with Prisma" and copy the `DATABASE_URL` for your `.env`
+![getting the connection string](./media/getting-connection-string.png)
-4. Switch to "Connect with Prisma" and copy the `DATABASE_URL` for `.env`
- (replace **\*\*\*** with password)
- <br/><img width="344" alt="Screenshot 2023-06-30 at 3 49 03 PM" src="https://github.com/bautistaaa/typehero/assets/31113245/4c9694ef-b954-47a8-9954-c2b677a1123a">
### 3. Create a new GitHub OAuth Application
@@ -137,7 +130,7 @@ UI Library: [shadcn](https://ui.shadcn.com/)
pnpm refresh
```
-This will cause prisma to force reset the database through the `db:reset`
+This will cause Prisma to force reset the database through the `db:reset`
command and then run `db:seed`.
</details>
diff --git a/media/connect.png b/media/connect.png
new file mode 100644
index 00000000..fac95304
Binary files /dev/null and b/media/connect.png differ
diff --git a/media/getting-connection-string.png b/media/getting-connection-string.png
new file mode 100644
index 00000000..b685c387
Binary files /dev/null and b/media/getting-connection-string.png differ