Skip to content

No1ceTea/no1cekeebs

Repository files navigation

No1cekeebs ⌨️

🚀 Project Structure

Inside of No1ceKeebs, you'll see the following folders and files:

/
├── public/
│   ├── assets/
│   │   └── logo.svg
│   │   └── logo.png
│   └── favicon.svg
│   └── robots.txt
│   └── 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.json

Astro looks for .astro or .md files in the src/pages/ directory. Each page is exposed as a route based on its file name.

Any static assets, like images, can be placed in the public/ directory.

All blog posts are stored in src/content/blog directory.

💻 Tech Stack

Main Framework - Astro Type Checking - TypeScript Component Framework - ReactJS Styling - TailwindCSS UI/UX - Figma Fuzzy Search - FuseJS Icons - Boxicons | Tablers Code Formatting - Prettier Deployment - Vercel Linting - ESLint

🧞 Commands

All commands are run from the root of the project, from a terminal:

Note! For Docker commands 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 cz Commit code changes with commitizen
npm run lint Lint with ESLint
docker compose up -d Run it 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.

✨ Feedback & Suggestions

If you have any suggestions/feedback, you can contact me via my email. Alternatively, feel free to open an issue if you find bugs or want to request new features or new article.