Skip to content

Commit

Permalink
chore: refactor md
Browse files Browse the repository at this point in the history
  • Loading branch information
brunotot committed May 16, 2024
1 parent 460e5f0 commit 826adc8
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 24 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ TOC
- [Understanding the repository name](#understanding-the-repository-name)
- [Installation](#installation)
- [GitHub repository setup](#github-repository-setup)
- [Local installation](#local-installation)
- [Railway setup](#railway-setup)
- [Local installation](#local-installation)

## Understanding the repository name

Expand Down Expand Up @@ -53,15 +53,7 @@ Each element of the repository name has been carefully chosen to reflect the cor

Navigate to **Repo > Settings > Pages** and save the `gh-pages` branch as the deployment branch.

5. That's it! Now your GitHub repository is ready to be used for deployment through Railway client.

---

### Local installation

1. Clone the previously created repository to your local machine.

2. Install local packages and run prepare scripts with `pnpm install`.
🚀 That's it! Now your GitHub repository is ready to be used for deployment through Railway client.

---

Expand Down Expand Up @@ -149,3 +141,17 @@ Each element of the repository name has been carefully chosen to reflect the cor
- Optionally you can generate a custom domain name on **Frontend > Settings > Networking > Generate Domain**

</details>

---

### Local installation

1. Clone the previously created repository to your local machine.

2. Install local packages and run prepare scripts with `pnpm install`.

3. Add required environment variables to `packages/backend/.env.development.

(Check **step 4** of Railway setup - **Setup Backend service** )

🚀 That's it! Try running `pnpm run backend:dev` or `pnpm run frontend:dev`
24 changes: 15 additions & 9 deletions md/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,7 @@

Navigate to **Repo > Settings > Pages** and save the `gh-pages` branch as the deployment branch.

5. That's it! Now your GitHub repository is ready to be used for deployment through Railway client.

---

### Local installation

1. Clone the previously created repository to your local machine.

2. Install local packages and run prepare scripts with `pnpm install`.
🚀 That's it! Now your GitHub repository is ready to be used for deployment through Railway client.

---

Expand Down Expand Up @@ -112,3 +104,17 @@
- Optionally you can generate a custom domain name on **Frontend > Settings > Networking > Generate Domain**

</details>

---

### Local installation

1. Clone the previously created repository to your local machine.

2. Install local packages and run prepare scripts with `pnpm install`.

3. Add required environment variables to `packages/backend/.env.development.

(Check **step 4** of Railway setup - **Setup Backend service** )

🚀 That's it! Try running `pnpm run backend:dev` or `pnpm run frontend:dev`
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@
"shared:build": "npm run build --prefix packages/shared",
"backend:start": "npm run start --prefix packages/backend",
"backend:build": "npm run build --prefix packages/backend",
"backend:dev": "npm run dev --prefix packages/backend",
"backend:dev": "cd packages/backend && npm run dev",
"backend:test": "npm run test --prefix packages/backend",
"frontend:dev": "npm run dev --prefix packages/frontend",
"frontend:dev": "cd packages/frontend && npm run dev",
"frontend:start": "npm run start --prefix packages/frontend",
"frontend:build": "npm run build --prefix packages/frontend",
"frontend:interface": "npm run interface --prefix packages/frontend",
Expand Down
4 changes: 1 addition & 3 deletions packages/backend/scripts/start.sh
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
#!/bin/bash

PWD_THIS=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )

source "${PWD_THIS}/shared/spinner.sh"
source "${PWD_THIS}/shared/colors.sh"

PWD_BACKEND="$PWD_THIS/.."

APP="$1"
VERSION="$2"

export PACKAGE_JSON_VERSION=$(grep -o '\"version\": *\"[^\"]*\"' package.json | awk -F'\"' '{print $4}')

rm -rf dist
Expand Down

0 comments on commit 826adc8

Please sign in to comment.