Repository navigation
Migrate Repository to TypeScript and Add Build and Lint Workflows #3
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
cc5c235
Migrate repo to TS
rahulc0dy 990864f
Add workflows, PR template and update README
rahulc0dy 3ff9707
Refactor ESLint configuration and update TypeScript settings
rahulc0dy b4cd00b
Add permissions section to workflows and update ESLint configuration …
rahulc0dy b729c6e
Update README.md to enhance project description, installation instruc…
rahulc0dy 20f9d6d
Fix badge links in README.md to point to the correct repository
rahulc0dy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ## Issue Reference | ||
|
|
||
| - Fixes #<!-- replace this comment with the issue number, e.g., 'Fixes #1234' --> | ||
|
|
||
| <!-- Add more Fixes # for multiple issues --> | ||
|
|
||
| <!-- This will be automatically replaced by a summary generated by CodeRabbitAI --> | ||
|
|
||
| @coderabbitai summary |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| name: Build | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v4 | ||
|
|
||
| - name: Setup Bun | ||
| uses: oven-sh/setup-bun@v2 | ||
| with: | ||
| bun-version: latest | ||
|
|
||
| - name: Install dependencies | ||
| run: bun install --frozen-lockfile | ||
|
|
||
| - name: Build | ||
| run: bun run build | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Lint & Format | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
| branches: [main] | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
| lint-format: | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v7 | ||
|
|
||
| - name: Setup Bun | ||
| uses: oven-sh/setup-bun@v2 | ||
| with: | ||
| bun-version: latest | ||
|
|
||
| - name: Install dependencies | ||
| run: bun install --frozen-lockfile | ||
|
|
||
| - name: Format Check | ||
| run: bun run format | ||
|
|
||
| - name: Lint Check | ||
| run: bun run lint | ||
|
coderabbitai[bot] marked this conversation as resolved.
Resolved
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| node_modules/ | ||
| dist/ | ||
| .next/ | ||
| .netlify/ | ||
| bun.lock | ||
| package-lock.json | ||
| yarn.lock | ||
| pnpm-lock.yaml |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| { | ||
| "semi": true, | ||
| "singleQuote": false, | ||
| "tabWidth": 2, | ||
| "trailingComma": "es5", | ||
| "useTabs": false | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,102 @@ | ||
| This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). | ||
| <div align="center"> | ||
|
|
||
| ## Getting Started | ||
| <img width="90" height="115" alt="transparent-makeshift-logo" src="public/logo.svg" /> | ||
|
|
||
| First, run the development server: | ||
| # Makeshift Blog | ||
|
|
||
| **The public website for Makeshift Engineering.** | ||
|
|
||
| [](https://github.com/makeshift-engineering/makeshift/actions/workflows/build.yml) | ||
| [](https://github.com/makeshift-engineering/makeshift/actions/workflows/lint.yml) | ||
|
|
||
| </div> | ||
|
|
||
| ## Technology | ||
|
|
||
| - [Next.js](https://nextjs.org/) App Router | ||
| - [React](https://react.dev/) | ||
| - [TypeScript](https://www.typescriptlang.org/) | ||
| - CSS Modules and global CSS design tokens | ||
| - [Bun](https://bun.sh/) for dependency management and scripts | ||
|
|
||
| The site uses `next/font` for its typography, static metadata for search and social sharing, and `public/logo.svg` as the site favicon and brand mark. | ||
|
|
||
| ## Project structure | ||
|
|
||
| ```text | ||
| makeshift/ | ||
| ├── .github/ | ||
| │ └── workflows/ | ||
| │ └── lint.yml # CI format and lint checks | ||
| ├── app/ | ||
| │ ├── components/ # Shared page components | ||
| │ │ ├── Footer/ | ||
| │ │ ├── HeroTerminal/ | ||
| │ │ ├── Navbar/ | ||
| │ │ └── ScrollReveal.tsx | ||
| │ ├── globals.css # Global styles and design tokens | ||
| │ ├── layout.tsx # Root layout and site metadata | ||
| │ ├── page.tsx # Homepage | ||
| │ └── page.module.css # Homepage styles | ||
| ├── public/ | ||
| │ └── logo.svg # Brand mark and favicon source | ||
| ├── eslint.config.mjs # ESLint flat configuration | ||
| ├── next.config.mjs # Next.js configuration | ||
| ├── package.json # Scripts and dependencies | ||
| ├── tsconfig.json # TypeScript configuration | ||
| └── bun.lock # Locked Bun dependency versions | ||
| ``` | ||
|
|
||
| ## Development | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| Install [Bun](https://bun.sh/docs/installation). The project uses the Bun lockfile, so Bun should be used for installation and scripts. | ||
|
|
||
| ### Installation | ||
|
|
||
| ```bash | ||
| git clone https://github.com/makeshift-engineering/makeshift.git | ||
| cd makeshift | ||
| bun install --frozen-lockfile | ||
| ``` | ||
|
|
||
| ### Run locally | ||
|
|
||
| Start the development server: | ||
|
|
||
| ```bash | ||
| npm run dev | ||
| # or | ||
| yarn dev | ||
| # or | ||
| pnpm dev | ||
| # or | ||
| bun dev | ||
| bun run dev | ||
| ``` | ||
|
|
||
| Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. | ||
| Open [http://localhost:3000](http://localhost:3000) in your browser. Changes to files under `app/` are reflected automatically. | ||
|
|
||
| You can start editing the page by modifying `app/page.js`. The page auto-updates as you edit the file. | ||
| ## Production | ||
|
|
||
| This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. | ||
| Create an optimised production build: | ||
|
|
||
| ## Learn More | ||
| ```bash | ||
| bun run build | ||
| ``` | ||
|
|
||
| Serve the generated build locally: | ||
|
|
||
| ```bash | ||
| bun run start | ||
| ``` | ||
|
|
||
| To learn more about Next.js, take a look at the following resources: | ||
| The application is a standard Next.js deployment and can be deployed to a platform with Next.js support, such as [Vercel](https://vercel.com/). Configure the deployment from the repository’s hosting provider and use `bun run build` as the build command. | ||
|
|
||
| - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. | ||
| - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. | ||
| ## Contributing | ||
|
|
||
| You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! | ||
| This repository contains the Makeshift Engineering website. If you find a problem or have an idea for improvement, open an issue or pull request in [makeshift-engineering/makeshift](https://github.com/makeshift-engineering/makeshift). | ||
|
|
||
| ## Deploy on Vercel | ||
| Please keep changes focused, preserve the existing visual language, and run all quality checks before submitting a pull request. | ||
|
|
||
| The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. | ||
| ## Related links | ||
|
|
||
| Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. | ||
| - [Makeshift Engineering](https://makeshift.pro) | ||
| - [GitHub organisation](https://github.com/makeshift-engineering) | ||
| - [Engineering blog](https://blog.makeshift.pro) | ||
| - [Makeshift Blog repository](https://github.com/makeshift-engineering/makeshift-blog) | ||
| - [PenguinDB](https://penguindb.makeshift.pro) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.