Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.68 KB

README.md

File metadata and controls

88 lines (62 loc) · 2.68 KB

This is my personal website built with the following stacks:

Running it locally 🏃‍♂️🏠

  1. Clone the project
git clone https://github.com/lucasdsalves/lucasdsalves.com.git
  1. Go to the project folder
cd lucasdsalves.com
  1. Install dependencies
npm install
  1. Run the development server:
npm start

or

npm run dev
  1. Open http://localhost:3000 with your browser to see the result.

Project structure 🏗️

📦 root
├── 📁 components             # React files to customize the components for the site
├── 📁 css                    # Tailwind and Prism CSS files
├── 📁 data                   # Files to change the content of pages
│ ├── 📁 authors              # Markdown files for authors of blog
│ ├── 📁 blog                 # Markdown files for blog posts
├── 📁 layouts                # JS Layouts for pages
├── 📁 lib                    # Non-react modules
├── 📁 pages                  # All page files for website
├── 📁 public                 # Static files for images, rss, and assets
│ ├── 📁 static               # Holds images, favicons, and other assets
│ │ ├── 📁 favicon            # Favicon files
│ │ └── 📁 images             # Image Files
│ ├── 📝 feed.xml             # RSS feed
├── 📁 scripts                # Scripts to run for different tasks
├── 📝 tailwind.config.js     # Contains tailwind stylesheet to change the look
└── 📝 next.config.js         # Configuration related to Next.js
└── 📝 prettier.config.js     # Configuration related to Prettier

Composing a new post ✏️

Run node ./scripts/compose.js to bootstrap a new post.

Inspiration and template origin 💡

This website was built based on Timothy Lin template Tailwind Nextjs Starter Blog.

Inspired by:

Licence 🗞️

MIT © Lucas dos Santos Alves