Skip to content

Commit

Permalink
chore: project init
Browse files Browse the repository at this point in the history
  • Loading branch information
mehdibha committed Dec 25, 2023
0 parents commit 30e2105
Show file tree
Hide file tree
Showing 241 changed files with 7,765 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .changeset/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Changesets

Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
with multi-package repos, or single-package repos to help you version and publish your code. You can
find the full documentation for it [in our repository](https://github.com/changesets/changesets)

We have a quick list of common questions to get you started engaging with this project in
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
11 changes: 11 additions & 0 deletions .changeset/config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
"changelog": "@changesets/cli/changelog",
"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
"baseBranch": "main",
"updateInternalDependencies": "patch",
"ignore": []
}
10 changes: 10 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
module.exports = require("@turbocharger/eslint-config/basic");
53 changes: 53 additions & 0 deletions .github/workflows/code-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: code check
on:
push:
branches: [dev, main]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install dependencies
run: yarn install

- name: Check linting
run: yarn run lint

format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install dependencies
run: yarn install

- name: Check format
run: yarn run format:check

tsc:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Install Node.js
uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install dependencies
run: yarn install

- name: Check types
run: yarn run typecheck
33 changes: 33 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Release

on:
push:
branches:
- main

concurrency: ${{ github.workflow }}-${{ github.ref }}

jobs:
release:
name: Release
runs-on: ubuntu-latest
steps:
- name: Checkout Repo
uses: actions/checkout@v3

- name: Setup Node.js 20.x
uses: actions/setup-node@v3
with:
node-version: 20.x

- name: Install Dependencies
run: yarn

- name: Create Release Pull Request or Publish to npm
id: changesets
uses: changesets/action@v1
with:
publish: yarn release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
37 changes: 37 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 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/
build
.swc/

# misc
.DS_Store
*.pem

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

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local
.env

# turbo
.turbo

# ui
dist/
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 -- 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
1 change: 1 addition & 0 deletions .npmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
auto-install-peers = true
31 changes: 31 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
module.exports = {
singleQuote: false,
bracketSpacing: true,
jsxSingleQuote: false,
bracketSameLine: false,
trailingComma: "es5",
semi: true,
printWidth: 90,
arrowParens: "always",
endOfLine: "auto",
importOrder: [
// Mocks must be at the top as they contain vi.mock calls
"(.*)/__mocks__/(.*)",
"^(react/(.*)$)|^(react$)",
"^(next/(.*)$)|^(next$)",
"<THIRD_PARTY_MODULES>",
"^@(turbocharger)/(.*)$",
"^(@/components/(.*)$)",
"^(@/hooks/(.*)$)",
"^(@/utils/(.*)$)",
"^(@/lib/(.*)$)",
"^(@/styles/(.*)$)",
"^(@/assets/(.*)$)",
"^(@/types/(.*)$)",
"^(@/(.*)$)",
"^~/(.*)$",
"^[./]",
],
importOrderSeparation: false,
plugins: ["@trivago/prettier-plugin-sort-imports", "prettier-plugin-tailwindcss"],
};
120 changes: 120 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
[![Stargazers][stars-shield]][stars-url][![Forks][forks-shield]][forks-url][![Contributors][contributors-shield]][contributors-url][![MIT License][license-shield]][license-url][![Issues][issues-shield]][issues-url]

<br/>
<div align="center">
<a href="https://github.com/mehdibha/turbocharger">
<img src="https://turbocharger.cc/images/logo.png" alt="Logo" width="80" height="80">
</a>
<h1 align="center">Turbocharger</h1>
<p align="center">
Turbocharge your project with this monorepo starter. It comes with Next.js, Tailwind CSS, Shadcn-ui, Server components, and more.
</p>
<p>

<a href="https://turbocharger.cc">View Demo</a>
·
<a href="https://github.com/mehdibha/turbocharger/issues">Report Bug</a>
·
<a href="https://github.com/mehdibha/turbocharger/issues">Request Feature</a>
</p>
</div>

<details>
<summary>Table of Contents</summary>
<ol>
<li><a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#features">Features</a></li>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li><a href="#getting-started">Getting Started</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#sites-using-notionfolio">Sites using turbocharger</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contributors">Contributors</a></li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project



<details open><summary>Screenshot</summary>
<img src="https://demo.notionfol.io/images/screenshots/screenshot01.png" />
</details>

### Features

- 📒 Writing posts using Notion as CMS
- 👀 Pretty URLs & SEO friendly
- 🤖 Entirely customisable through one config file
- 🚀 Fast page views
- 💼 Sleek Portfolio -> Showcase your work elegantly and professionally.
- 🌓 Dark and light mode
- 📱 Responsive design
- ♻️ Incremental static regeneration (Every x minutes re-update website content so no need to redeploy)
- 📰 RSS feed
- 🚀 Deploy on Vercel in minutes
- 🔍 Search posts instantly
- 📈 Analytics with vercel analytics
- Dispaly your courses


### Built with

- Next.js (v14 with app dir) and React
- Typescript
- Tailwind CSS
- Shadcn-ui as starter components

## Getting Started

If you want to clone the project and make you personal notionfolio

### Configuratuion
- Star the repo
- Fork this project
- config env variable (see .env.exemple)
-

## Roadmap

- [x] Init project
- [x] Linting tools

## Sites using notionfol.io

We will be happy to mention you here, just make a pull request and we will add you

<!-- CONTRIBUTING -->

## Contributing

See the [contribution guide](CONTRIBUTING.md) and join our amazing list of [contributors](https://github.com/mehdibha/turbocharger/graphs/contributors)!

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contributors

<table><tr align="left">
<td align="center"><a href="https://github.com/mehdibha"><img src="https://avatars.githubusercontent.com/u/12223900?v=4" width="64px;"alt="Mehdi BHA"/><br/><sub><b>Mehdi BHA</b></sub></a></td>
</tr></table>

[contributors-shield]: https://img.shields.io/github/contributors/mehdibha/turbocharger.svg?style=for-the-badge
[contributors-url]: https://github.com/mehdibha/turbocharger/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/mehdibha/turbocharger.svg?style=for-the-badge
[forks-url]: https://github.com/mehdibha/turbocharger.svg/network/members
[stars-shield]: https://img.shields.io/github/stars/mehdibha/turbocharger.svg?style=for-the-badge
[stars-url]: https://github.com/mehdibha/turbocharger.svg/stargazers
[issues-shield]: https://img.shields.io/github/issues/mehdibha/turbocharger.svg?style=for-the-badge
[issues-url]: https://github.com/mehdibha/turbocharger.svg/issues
[license-shield]: https://img.shields.io/github/license/mehdibha/turbocharger.svg?style=for-the-badge
[license-url]: https://github.com/mehdibha/turbocharger.svg/blob/master/LICENSE.txt
3 changes: 3 additions & 0 deletions apps/app/.eslintrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ["@turbocharger/eslint-config/basic"],
};
34 changes: 34 additions & 0 deletions apps/app/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 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
*.pem

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

# local env files
.env.local
.env.development.local
.env.test.local
.env.production.local

# vercel
.vercel
28 changes: 28 additions & 0 deletions apps/app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Getting Started

First, run the development server:

```bash
yarn dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `src/app/page.tsx`. The page auto-updates as you edit the file.

To create [API routes](https://nextjs.org/docs/app/building-your-application/routing/router-handlers) add an `api/` directory to the `app/` directory with a `route.ts` file. For individual endpoints, create a subfolder in the `api` directory, like `api/hello/route.ts` would map to [http://localhost:3000/api/hello](http://localhost:3000/api/hello).

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn/foundations/about-nextjs) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_source=github.com&utm_medium=referral&utm_campaign=turborepo-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Loading

0 comments on commit 30e2105

Please sign in to comment.