Skip to content

Commit

Permalink
removing deployment to github pages documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pradeepngupta committed Jan 14, 2025
1 parent 317d8d6 commit 9d7abfd
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 37 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ _"Kickstart your modern web development journey effortlessly!"_

![TSWindRush Stack](./assets/ts-windrush.svg)

![Next.js](https://img.shields.io/badge/Next.js-v13.0-blue) ![TypeScript](https://img.shields.io/badge/TypeScript-v4.0-blue) ![TailwindCSS](https://img.shields.io/badge/TailwindCSS-v3.0-green)
![Next.js](https://img.shields.io/badge/Next.js-v15.1.4-blue) ![TypeScript](https://img.shields.io/badge/TypeScript-v5.7.3-blue) ![TailwindCSS](https://img.shields.io/badge/TailwindCSS-v3.4.17-green)

🚀 TSWindRush is a blazing-fast, developer-friendly starter template combining Next.js, TypeScript, and TailwindCSS for modern web development.

Expand Down Expand Up @@ -59,13 +59,11 @@ Before you start using Next JS, make sure you have the following prerequisites:

## 🚀 Live Demo

This starter template is deployed on Vercel and on Github Pages (using Static Export)
This starter template is deployed on Vercel

[Vercel App](https://nextjs-typescript-tailwindcss-murex.vercel.app/)
[Vercel App](https://tsw-ind-rush-pradeepnguptas-projects.vercel.app/)

[Github Pages](https://pradeepngupta.github.io/nextjs-typescript-tailwindcss/)

This project is pre-configured with the deployment on Vercel and Github pages. For detailed instructions, refer to the [DEPLOYMENT](./docs/DEPLOYMENT.md).
This project is pre-configured with the deployment on Vercel. For detailed instructions, refer to the [DEPLOYMENT](./docs/DEPLOYMENT.md).

## 🛠️ Setup & Installation

Expand Down
Binary file modified assets/tech-stack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 28 additions & 16 deletions docs/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,37 @@ Production Build can be get by running the command `npm run build`
The output of this command:

```bash
build
next build
▲ Next.js 15.1.4
✓ Linting and checking validity of types

> build
> next build

▲ Next.js 15.1.4
- Environments: .env

Creating an optimized production build ...
✓ Compiled successfully
Skipping linting
✓ Checking validity of types
✓ Collecting page data
✓ Generating static pages (3/3)
✓ Generating static pages (10/10)
✓ Collecting build traces
✓ Finalizing page optimization

Route (pages) Size First Load JS
┌ ○ / 6.3 kB 97.7 kB
├ └ css/f7bac67f9d9badbc.css 657 B
├ /_app 0 B 91.4 kB
├ ○ /404 2.42 kB 93.8 kB
└ ƒ /api/hello 0 B 91.4 kB
First Load JS shared by all 91.6 kB
├ chunks/framework-a4ddb9b21624b39b.js 57.5 kB
├ chunks/main-4212ba9651e5cb31.js 31.9 kB
└ other shared chunks (total) 2.24 kB
Route (app) Size First Load JS
┌ ○ / 5.57 kB 111 kB
├ ○ /_not-found 979 B 106 kB
├ ○ /apple-icon.png 0 B 0 B
├ ○ /icon.png 0 B 0 B
├ ○ /manifest.json 0 B 0 B
├ ○ /robots.txt 0 B 0 B
└ ○ /sitemap.xml 0 B 0 B
+ First Load JS shared by all 105 kB
├ chunks/4bd1b696-20882bf820444624.js 52.9 kB
├ chunks/517-da775dc7c050d5b8.js 50.5 kB
└ other shared chunks (total) 1.95 kB


○ (Static) prerendered as static content
```

- The build output generated is in .next folder.
Expand Down Expand Up @@ -80,6 +90,8 @@ Learn more about [Next.js on Vercel](https://vercel.com/docs/frameworks/nextjs?u

### Deployment to GitHub Pages

GitHub Pages deployment is not done for this repository.

Steps:

1. Enable Pages in Github Repository to use Github Actions (Settings / Pages)
Expand All @@ -90,4 +102,4 @@ Steps:

Go to Settings / Pages, you will see

Your site is live at [https://pradeepngupta.github.io/nextjs-typescript-tailwindcss/](https://pradeepngupta.github.io/nextjs-typescript-tailwindcss/)
Your site is live at URL
7 changes: 0 additions & 7 deletions docs/TechStack.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
- [PostCSS \& Auto-Prefixer](#postcss--auto-prefixer)
- [Deployment \& Hosting](#deployment--hosting)
- [Vercel](#vercel)
- [Github Pages](#github-pages)
- [Continuous Integration / Continuous Deployment](#continuous-integration--continuous-deployment)
- [Github Actions](#github-actions)
- [Static Code Analysis](#static-code-analysis)
Expand Down Expand Up @@ -134,12 +133,6 @@ While Next.js works when self-hosting, deploying to Vercel is zero-configuration

Vercel supports [popular frontend frameworks](https://vercel.com/docs/frameworks) out-of-the-box, and its scalable, secure infrastructure is globally distributed to serve content from data centers near your users for optimal speeds.

### Github Pages

GitHub Pages are public webpages hosted and published through GitHub.

Github Pages are quick to showcase open source stativ web application.

## Continuous Integration / Continuous Deployment

### Github Actions
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "nextjs-typescript-tailwindcss",
"homepage": "https://pradeepngupta.github.io/nextjs-typescript-tailwindcss/",
"name": "tswindrush",
"homepage": "https://tsw-ind-rush-pradeepnguptas-projects.vercel.app/",
"author": "Pradeep Gupta <pradeepngupta@gmail.com>",
"repository": {
"type": "git",
"url": "https://github.com/pradeepngupta/nextjs-typescript-tailwindcss.git"
"url": "https://github.com/pradeepngupta/tswindrush.git"
},
"scripts": {
"dev": "next dev",
Expand Down Expand Up @@ -56,7 +56,8 @@
"prettier": "3.4.2",
"tailwindcss": "3.4.17",
"ts-jest": "29.2.5",
"ts-node": "10.9.2"
"ts-node": "10.9.2",
"typescript": "5.7.3"
},
"engines": {
"node": ">=16"
Expand Down

0 comments on commit 9d7abfd

Please sign in to comment.