Skip to content

Commit

Permalink
Merge pull request #65 from Z-100/Update-Readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
Z-100 authored Feb 12, 2024
2 parents eef7a26 + c0af841 commit 50a320e
Showing 1 changed file with 11 additions and 32 deletions.
43 changes: 11 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Vayan - Portfolio/CV page

Basically the title
# Vayan - CV page

I'm not a React- nor frontend-dev, but I'm trying my best :)

Expand All @@ -10,37 +8,18 @@ Clone the repository using the terminal or your IDE:

```shell
> git clone https://github.com/Z-100/vayan.git
```

After cloning the repository, open any terminal at the project's root directory - (That's the folder containing the
package.json file).

Then run the following command:
```shell
> npm i -D
```

If you try to start the app now, it'll probably start but won't work properly. That's because some very important
configuration is missing: The `.env.local` stuff.

Create a file called `.env.local` at the project root and fill in the information below:
```properties
REACT_APP_ENV=DEV
POSTGRES_HOST=...
POSTGRES_URL=...
POSTGRES_USER=...
POSTGRES_PASSWORD=...
POSTGRES_DATABASE=...
```

To start the app, simply run the following command in that very same terminal:
```shell
> npm i
> npm run start
```
## Checklist

## CI/CD

## Useful docs
| Status | Thing |
|:---------------:|:----------------|
| :x: | Define content |
| :x: | Write content |
| :x: | Make pretty |
| :grey_question: | Dynamic content |

[Tailwind size comparison](https://www.techighness.com/post/size-conversion-cheatsheet-pixel-tailwind-classes-rem/)
## Future stuff

- Deploy on [personal k8s](https://github.com/Z-100/k8s)

0 comments on commit 50a320e

Please sign in to comment.