diff --git a/README.md b/README.md index 4186016..8261ff9 100644 --- a/README.md +++ b/README.md @@ -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 :) @@ -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)