Skip to content

Commit

Permalink
feat: Init next app (#15)
Browse files Browse the repository at this point in the history
* feat: init next app

* feat: clean up project
  • Loading branch information
Skolaczk committed Feb 11, 2024
1 parent 5a6f938 commit 53fa269
Show file tree
Hide file tree
Showing 72 changed files with 8,183 additions and 29,158 deletions.
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
dist/*
.cache
public
node_modules
*.esm.js
36 changes: 0 additions & 36 deletions .eslintrc

This file was deleted.

45 changes: 45 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
module.exports = {
parser: '@typescript-eslint/parser',
extends: [
'next/core-web-vitals',
'prettier',
'eslint:recommended',
'plugin:prettier/recommended',
'plugin:@typescript-eslint/recommended',
'plugin:tailwindcss/recommended',
],
plugins: ['simple-import-sort', 'prettier', '@typescript-eslint'],
rules: {
'prettier/prettier': [
'error',
{
endOfLine: 'auto',
},
],
'sort-imports': 'off',
'tailwindcss/no-custom-classname': 'off',
'@typescript-eslint/no-var-requires': 'off',
'simple-import-sort/imports': [
2,
{
groups: [
['^.+\\.s?css$'],
[
`^(${require('module').builtinModules.join('|')})(/|$)`,
'^react',
'^@?\\w',
],
['^components(/.*|$)'],
['^lib(/.*|$)', '^hooks(/.*|$)'],
['^\\.'],
],
},
],
},
settings: {
tailwindcss: {
callees: ['cn'],
config: 'tailwind.config.js',
},
},
};
9 changes: 9 additions & 0 deletions .github/issue-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
### Describe the feature / bug 📝:

N/A

### Steps to reproduce the bug 🔁:

1.
2.
3.
11 changes: 11 additions & 0 deletions .github/pull-request-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### Issue 😱:

Closes https://github.com/Skolaczk/next-starter/issues

### What has been done ✅:

- [ ]

### Screenshots/Videos 🎥:

N/A
21 changes: 21 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Code check

on:
pull_request:
branches:
- main

jobs:
lint:
name: Eslint, Typescript, prettier
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install dependencies
run: npm install
- name: ESLint
run: npm run lint
- name: Type check
run: npm run typecheck
- name: Prettier
run: npm run format:check
53 changes: 49 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,49 @@
node_modules/
.cache/
public
.env
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# dependencies
/node_modules
/.pnp
.pnp.js

# testing
/coverage

# next.js
/.next/
/out/

# production
/build

# misc
.DS_Store
.idea
*.pem

# debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# local env files
.env
.env*.local

# vercel
.vercel

# typescript
*.tsbuildinfo
next-env.d.ts

# eslint cache
.eslintcache

# next-sitemap
robots.txt
sitemap.xml
sitemap-*.xml
/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install commitlint --edit "$1"
4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx lint-staged
4 changes: 4 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules
/public
/dist
/build
8 changes: 8 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
endOfLine: 'auto',
semi: true,
singleQuote: true,
jsxSingleQuote: false,
trailingComma: 'es5',
tabWidth: 2,
};
57 changes: 1 addition & 56 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1 @@
<h3 align="center">Portfolio</h3>

## Project Overview 🎉

It's my portfolio page made in Gatsby.js. I used this technology because gatsby is a static page generator which was perfect for this project. I organized the structure of the projects, splitting them into assets, components, hooks, templates and pages. On this page you can find information about me You can also send an email directly from the website. This functionality was done using the <a href="https://www.emailjs.com/">EmailJS</a> tool. Remember about the correct data in the form as it is validated!

## Installation 💾

Download the project to your computer and install needed packages with command:

```sh
npm install
```

Then start the project on the local server with the command:

```sh
npm start
```

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

## Live 📍

Link to the live version: https://michalskolak.netlify.app/

## Tech/framework used 🔧

| Tech | Description |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Gatsby.js | It's a static site generator based on react. |
| Styled-components | Great library for styling components in an application. The biggest advantage of this library is writing styles in js, so we can use conditional statements and other things from javascript there. |
| EmailJS | It's technology for sending e-mails from the website without back-end functions. |
| GSAP | It's library for advenced animations. I used it with ScrollTrigger plugin |
| Formik, Yup | These library help maintain and validate form. |
| Eslint, Prettier | These tools help keep code clean in project. |

## Screenshots 📺

<p align="center">
<img src="https://user-images.githubusercontent.com/76774237/188315065-7d8cfbbc-4a80-4e6b-a066-f9963357a14a.png" alt="Screenshot">
</p>

<p align="center">
<img src="https://user-images.githubusercontent.com/76774237/188315072-d6029ee5-9e8d-4843-af82-79f37856c766.png" alt="Screenshot">
</p>

## Available scripts

| Command | Description |
| --------------- | ---------------------- |
| `npm run start` | Open local server |
| `npm run build` | Create optimized build |
| `npm run clean` | Clean .cache folder |

If you encounter a problem, write to this e-mail address: [skolakmichal1@gmail.com](mailto:skolakmichal1@gmail.com)
# Portfolio
1 change: 1 addition & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = { extends: ['@commitlint/config-conventional'] };
6 changes: 0 additions & 6 deletions gatsby-browser.js

This file was deleted.

77 changes: 0 additions & 77 deletions gatsby-config.js

This file was deleted.

6 changes: 0 additions & 6 deletions gatsby-ssr.js

This file was deleted.

8 changes: 8 additions & 0 deletions next-sitemap.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
module.exports = {
siteUrl: process.env.NEXT_PUBLIC_SITE_URL || '',
generateRobotsTxt: true,
generateIndexSitemap: false,
robotsTxtOptions: {
policies: [{ userAgent: '*', allow: '/' }],
},
};
4 changes: 4 additions & 0 deletions next.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/** @type {import('next').NextConfig} */
const nextConfig = {};

module.exports = nextConfig;
Loading

0 comments on commit 53fa269

Please sign in to comment.