-
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.
Merge pull request #1 from Z-100/develop
New release
- Loading branch information
Showing
49 changed files
with
1,266 additions
and
740 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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,9 +1,46 @@ | ||
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/"> | ||
<img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png" /> | ||
</a> | ||
|
||
# Vayan - Portfolio/CV page | ||
|
||
Basically the title | ||
|
||
I'm not a React- nor frontend-dev, but I'm trying my best :) | ||
I'm not a React- nor frontend-dev, but I'm trying my best :) | ||
|
||
## Run the app | ||
|
||
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 run start | ||
``` | ||
|
||
## CI/CD | ||
|
||
## Useful docs | ||
|
||
[Tailwind size comparison](https://www.techighness.com/post/size-conversion-cheatsheet-pixel-tailwind-classes-rem/) | ||
|
Oops, something went wrong.