Updated README
This commit is contained in:
10
README.md
10
README.md
@@ -38,7 +38,8 @@ To run this project locally, you'll need:
|
|||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
4. **create an .env file**
|
4. **create an .env file**
|
||||||
> this is for the contact section, and some email features. This should be your email as this is designed to inform yourself about contact attemps.
|
> this is for the contact section, and enables email notification features. This should be your email as this is designed to inform yourself about contact attemps.
|
||||||
|
> Be warned: if using a gmail, you will need to setup an app password and use that instead of your own private email password.
|
||||||
```
|
```
|
||||||
EMAIL_ADDDRESS=
|
EMAIL_ADDDRESS=
|
||||||
EMAIL_PASSWORD=
|
EMAIL_PASSWORD=
|
||||||
@@ -57,7 +58,7 @@ To run this project locally, you'll need:
|
|||||||
## Folder Structure
|
## Folder Structure
|
||||||
|
|
||||||
```plaintext
|
```plaintext
|
||||||
kleinpanic-website/
|
kleinpanicWeb/
|
||||||
│
|
│
|
||||||
├── public/ # Static files (CSS, images, etc.)
|
├── public/ # Static files (CSS, images, etc.)
|
||||||
├── views/ # Frontend templates (ejs)
|
├── views/ # Frontend templates (ejs)
|
||||||
@@ -65,7 +66,12 @@ kleinpanic-website/
|
|||||||
├── blog/ # Dir to contain blogs
|
├── blog/ # Dir to contain blogs
|
||||||
├── package.json # NPM installs.
|
├── package.json # NPM installs.
|
||||||
├── server.js # Entry point for the server
|
├── server.js # Entry point for the server
|
||||||
|
├── .env # Text file for containing secrets
|
||||||
|
├── stderr.log # Log file created for error logs
|
||||||
|
├── package.json # File for JS dependencies
|
||||||
|
├── LICENSE # MIT License
|
||||||
└── README.md # Project documentation
|
└── README.md # Project documentation
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
@@ -3,4 +3,4 @@
|
|||||||
[38;5;199m| '[39m[38;5;164m /|[39m[38;5;164m | ___ [39m[38;5;129m _[39m[38;5;129m _ __ [39m[38;5;93m| |__) |[39m[38;5;93m_ _ [39m[38;5;63m_ __ [39m[38;5;63m _ [39m[38;5;33m___[39m
|
[38;5;199m| '[39m[38;5;164m /|[39m[38;5;164m | ___ [39m[38;5;129m _[39m[38;5;129m _ __ [39m[38;5;93m| |__) |[39m[38;5;93m_ _ [39m[38;5;63m_ __ [39m[38;5;63m _ [39m[38;5;33m___[39m
|
||||||
[38;5;164m| [39m[38;5;129m < |[39m[38;5;129m |/ _ \[39m[38;5;93m| | '_ \[39m[38;5;63m| ___/[39m[38;5;63m _` |[39m[38;5;33m '_ \[39m[38;5;33m| |[39m[38;5;39m/ __|[39m
|
[38;5;164m| [39m[38;5;129m < |[39m[38;5;129m |/ _ \[39m[38;5;93m| | '_ \[39m[38;5;63m| ___/[39m[38;5;63m _` |[39m[38;5;33m '_ \[39m[38;5;33m| |[39m[38;5;39m/ __|[39m
|
||||||
[38;5;129m| .[39m[38;5;93m \|[39m[38;5;93m | __/[39m[38;5;63m| | | |[39m[38;5;33m | | |[39m[38;5;33m (_| |[39m[38;5;39m | |[39m[38;5;39m | | [39m[38;5;44m(__ [39m
|
[38;5;129m| .[39m[38;5;93m \|[39m[38;5;93m | __/[39m[38;5;63m| | | |[39m[38;5;33m | | |[39m[38;5;33m (_| |[39m[38;5;39m | |[39m[38;5;39m | | [39m[38;5;44m(__ [39m
|
||||||
[38;5;93m|_|\[39m[38;5;63m_\_|[39m[38;5;63m\___|[39m[38;5;33m|_|_| |_|[39m[38;5;39m_| \__,_|[39m[38;5;44m_| |_|[39m[38;5;44m_|\___|[39m
|
[38;5;93m|_|\[39m[38;5;63m_\_|[39m[38;5;63m\___|[39m[38;5;33m|_|_| |_|[39m[38;5;39m_| \__,_|[39m[38;5;44m_| |_|[39m[38;5;44m_|\___|[39m
|
||||||
|
|||||||
Reference in New Issue
Block a user