Skip to content
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

Feature/NS-18-finish-beta-release #49

Merged
merged 2 commits into from
Jan 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- 📘 Typescript
- 🎨 TailwindCSS - Class sorting, merging and linting
- 🛠️ Shadcn/ui - Customizable UI components
- 🧪 Jest and React Testing Library - Configured for unit testing
- 🧪 Jest & React Testing Library - Configured for unit testing
- 📈 Absolute Import & Path Alias - Import components using `@/` prefix
- 💅 Prettier - Code formatter
- 🧹 Eslint - Code linting tool
Expand Down Expand Up @@ -39,7 +39,14 @@
npm install
```

### 3. Run the dev server
### 3. Prepare husky
It is required if you want husky to work

```bash
npm run prepare
```

### 4. Run the dev server

You can start the server using this command:

Expand All @@ -48,3 +55,8 @@ npm run dev
```

and open http://localhost:3000/ to see this app.


If you liked the project, I will appreciate if you leave a star. 🌟😊

Made by <a href="https://michalskolak.netlify.app/">Michał Skolak</a>
4 changes: 2 additions & 2 deletions next.config.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/** @type {import('next').NextConfig} */
const nextConfig = {}
const nextConfig = {};

module.exports = nextConfig
module.exports = nextConfig;
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "next-starter",
"version": "0.1.0",
"version": "1.0.0",
"private": true,
"scripts": {
"dev": "next dev --turbo",
Expand Down
2 changes: 1 addition & 1 deletion src/app/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const Home = () => {
<div className="mt-2 flex gap-4">
<Button asChild>
<a
href="https://github.com/Skolaczk/next-starter/blob/main/README.md"
href="https://github.com/Skolaczk/next-starter/blob/main/README.md#getting-started"
target="_blank"
>
Get Started
Expand Down
4 changes: 3 additions & 1 deletion src/lib/constant.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ export const siteConfig = {
'husky',
'lint-staged',
'Jest Tests',
'Github actions',
'Web Development',
'Starter Template',
'Next.js starter',
'Frontend',
'React',
'JavaScript',
Expand All @@ -24,5 +26,5 @@ export const siteConfig = {
'Efficient Development',
'Code Quality',
],
url: process.env.NEXT_PUBLIC_SITE_URL || '',
url: process.env.NEXT_PUBLIC_SITE_URL || 'https://example.com',
};
Loading