/
├── public/
│ ├── assets/
│ └── toggle-theme.js
├── src/
│ ├── assets/
│ │ └── socialIcons.ts
│ ├── components/
│ ├── content/
│ │ | blog/
│ │ | └── some-blog-posts.md
│ │ └── config.ts
│ ├── layouts/
│ └── pages/
│ └── styles/
│ └── utils/
│ └── config.ts
│ └── types.ts
└── package.jsonAstro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.
All blog posts are stored in src/content/blog directory.
Main Framework - Astro
Type Checking - TypeScript
Component Framework - ReactJS
Styling - TailwindCSS
Fuzzy Search - FuseJS
Icons - Boxicons | Tablers
Code Formatting - Prettier
Illustration in About Page - https://freesvgillustration.com
Linting - ESLint
# install dependencies
npm run install
# start running the project
npm run devAs an alternative approach, if you have Docker installed, you can use Docker to run this project locally. Here's how:
# Build the Docker image
docker build -t wilsonpage .
# Run the Docker container
docker run -p 4321:80 wilsonpageYou can easily add your Google Site Verification HTML tag using environment variable. This step is optional. If you don't add the following env variable, the google-site-verification tag won't appear in the html <head> section.
# in your environment variable file (.env)
PUBLIC_GOOGLE_SITE_VERIFICATION=your-google-site-verification-valueAll commands are run from the root of the project, from a terminal:
Note! For
Dockercommands we must have it installed in your machine.
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run format:check |
Check code format with Prettier |
npm run format |
Format codes with Prettier |
npm run sync |
Generates TypeScript types for all Astro modules. Learn more. |
npm run lint |
Lint with ESLint |
docker compose up -d |
Run WilsonPage on docker, You can access with the same hostname and port informed on dev command. |
docker compose run app npm install |
You can run any command above into the docker container. |
docker build -t wilsonpage . |
Build Docker image for WilsonPage. |
docker run -p 4321:80 wilsonpage |
Run WilsonPage on Docker. The website will be accessible at http://localhost:4321. |
If you have any suggestions/feedback, feel free to open an issue if you find bugs or want to request new features.
Licensed under the MIT License, Copyright © 2024